< Back
Enable-AzureBatchTask
Post
NAME Enable-AzureBatchTask
SYNOPSIS
Reactivates a task.
SYNTAX
Enable-AzureBatchTask [-JobId] <String> [-Id] <String> -BatchContext <BatchAccountContext> [-DefaultProfile <IAzureContextContainer>] [-Confirm]
[-WhatIf] [<CommonParameters>]
Enable-AzureBatchTask [-Task] <PSCloudTask> -BatchContext <BatchAccountContext> [-DefaultProfile <IAzureContextContainer>] [-Confirm] [-WhatIf]
[<CommonParameters>]
DESCRIPTION
The Enable-AzureBatchTask cmdlet reactivates a task. If a task has exhausted its retry count, this cmdlet nevertheless enables it to run.
PARAMETERS
-BatchContext <BatchAccountContext>
Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. If you use the Get-AzureRmBatchAccount
cmdlet to get your BatchAccountContext, then Azure Active Directory authentication will be used when interacting with the Batch service. To
use shared key authentication instead, use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys
populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the
BatchAccountContext.KeyInUse property.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Id <String>
Specifies the ID of the task to reactivate.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-JobId <String>
Specifies the ID of the job that contains the task.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Task <PSCloudTask>
Specifies the task that this cmdlet reactivates. To obtain a PSCloudTask object, use the Get-AzureBatchTask cmdlet.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
BatchAccountContext
Parameter 'BatchContext' accepts value of type 'BatchAccountContext' from the pipeline
PSCloudTask
Parameter 'Task' accepts value of type 'PSCloudTask' from the pipeline
OUTPUTS
NOTES
Example 1: Reactivate a task
PS C:\\>Enable-AzureBatchTask -JobId "Job7" -Id "Task2" -BatchContext $Context
This command reactivates the task Task2 in job Job7.
Example 2: Reactivate a task by using the pipeline
PS C:\\>Get-AzureBatchTask -JobId "Job8" -Id "Task3" -BatchContext $Context | Enable-AzureBatchTask -BatchContext $Context
This command gets the Batch task that has the ID Task3 in the job that has the ID Job8 by using the Get-AzureBatchTask cmdlet. The command passes
that task to the current cmdlet by using the pipeline operator. The command reactivates that task.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... ebatchtask
Get-AzureRmBatchAccountKeys
Get-AzureBatchTask
New-AzureBatchTask
Remove-AzureBatchTask
Set-AzureBatchTask
Stop-AzureBatchTask
SYNOPSIS
Reactivates a task.
SYNTAX
Enable-AzureBatchTask [-JobId] <String> [-Id] <String> -BatchContext <BatchAccountContext> [-DefaultProfile <IAzureContextContainer>] [-Confirm]
[-WhatIf] [<CommonParameters>]
Enable-AzureBatchTask [-Task] <PSCloudTask> -BatchContext <BatchAccountContext> [-DefaultProfile <IAzureContextContainer>] [-Confirm] [-WhatIf]
[<CommonParameters>]
DESCRIPTION
The Enable-AzureBatchTask cmdlet reactivates a task. If a task has exhausted its retry count, this cmdlet nevertheless enables it to run.
PARAMETERS
-BatchContext <BatchAccountContext>
Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. If you use the Get-AzureRmBatchAccount
cmdlet to get your BatchAccountContext, then Azure Active Directory authentication will be used when interacting with the Batch service. To
use shared key authentication instead, use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys
populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the
BatchAccountContext.KeyInUse property.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Id <String>
Specifies the ID of the task to reactivate.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-JobId <String>
Specifies the ID of the job that contains the task.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Task <PSCloudTask>
Specifies the task that this cmdlet reactivates. To obtain a PSCloudTask object, use the Get-AzureBatchTask cmdlet.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
BatchAccountContext
Parameter 'BatchContext' accepts value of type 'BatchAccountContext' from the pipeline
PSCloudTask
Parameter 'Task' accepts value of type 'PSCloudTask' from the pipeline
OUTPUTS
NOTES
Example 1: Reactivate a task
PS C:\\>Enable-AzureBatchTask -JobId "Job7" -Id "Task2" -BatchContext $Context
This command reactivates the task Task2 in job Job7.
Example 2: Reactivate a task by using the pipeline
PS C:\\>Get-AzureBatchTask -JobId "Job8" -Id "Task3" -BatchContext $Context | Enable-AzureBatchTask -BatchContext $Context
This command gets the Batch task that has the ID Task3 in the job that has the ID Job8 by using the Get-AzureBatchTask cmdlet. The command passes
that task to the current cmdlet by using the pipeline operator. The command reactivates that task.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... ebatchtask
Get-AzureRmBatchAccountKeys
Get-AzureBatchTask
New-AzureBatchTask
Remove-AzureBatchTask
Set-AzureBatchTask
Stop-AzureBatchTask