Set-AzBatchTask
Updates the properties of a task.
Syntax
Set-AzBatchTask
[-Task] <PSCloudTask>
-BatchContext <BatchAccountContext>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Description
The Set-AzBatchTask cmdlet updates the properties of a task in the Azure Batch service. Use the Get-AzBatchTask cmdlet to get a PSCloudTask object. Modify the properties of that object, and then use the current cmdlet to commit your changes to the Batch service.
Examples
Example 1: Update a task
$Task = Get-AzBatchTask -JobId "Job16" -Id "Task22" -BatchContext $Context
$Constraints = New-Object Microsoft.Azure.Commands.Batch.Models.PSTaskConstraints -ArgumentList @([TimeSpan]::FromDays(5), [TimeSpan]::FromDays(2), 3)
$Task.Constraints = $Constraints
Set-AzBatchTask -Task $Task -BatchContext $ContextThe first command gets a task by using Get-AzBatchTask, and then stores it in the $Task variable. The next two commands modify the constraints of the task in $Task. The final command updates the Batch service to match the local object in $Task.
Parameters
-BatchContext
Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. If you use the Get-AzBatchAccount cmdlet to get your BatchAccountContext, then Microsoft Entra authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzBatchAccountKey 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.
| Type: | BatchAccountContext |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with azure.
| Type: | IAzureContextContainer |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Task
Specifies the PSCloudTask to which this cmdlet updates the Batch service.
| Type: | PSCloudTask |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
