Set-AzBatchJob
Updates a Batch job.
Syntax
Set-AzBatchJob
[-Job] <PSCloudJob>
-BatchContext <BatchAccountContext>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Description
The Set-AzBatchJob cmdlet updates an Azure Batch job. Use the Get-AzBatchJob cmdlet to get a PSCloudJob 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 job
$Job = Get-AzBatchJob -Id "Job17" -BatchContext $Context
$Job.Priority = 1
Set-AzBatchJob -Job $Job -BatchContext $ContextThe first command gets a job by using Get-AzBatchJob, and then stores it in the $Job variable. The second command modifies the priority specification on the $Job object. The final command updates the Batch service to match the local object in $Job.
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 |
-Job
Specifies a PSCloudJob to which this cmdlet updates the Batch service.
| Type: | PSCloudJob |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
