< Back
Set-AzureBatchJob
Post
NAME Set-AzureBatchJob
SYNOPSIS
Updates a Batch job.
SYNTAX
Set-AzureBatchJob [-Job] <PSCloudJob> -BatchContext <BatchAccountContext> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
DESCRIPTION
The Set-AzureBatchJob cmdlet updates an Azure Batch job. Use the Get-AzureBatchJob 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.
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
-Job <PSCloudJob>
Specifies a PSCloudJob to which this cmdlet updates the Batch service.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByValue)
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
PSCloudJob
Parameter 'Job' accepts value of type 'PSCloudJob' from the pipeline
OUTPUTS
NOTES
Example 1: Update a job
PS C:\\>$Job = Get-AzureBatchJob -Id "Job17" -BatchContext $Context
PS C:\\> $Job.Priority = 1
PS C:\\> Set-AzureBatchJob -Job $Job -BatchContext $Context
The first command gets a pool by using Get-AzureBatchJob , 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.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... rebatchjob
Disable-AzureBatchJob
Enable-AzureBatchJob
Get-AzureBatchJob
Get-AzureRmBatchAccountKeys
New-AzureBatchJob
Remove-AzureBatchJob
Stop-AzureBatchJob
Azure Batch Cmdlets
SYNOPSIS
Updates a Batch job.
SYNTAX
Set-AzureBatchJob [-Job] <PSCloudJob> -BatchContext <BatchAccountContext> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
DESCRIPTION
The Set-AzureBatchJob cmdlet updates an Azure Batch job. Use the Get-AzureBatchJob 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.
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
-Job <PSCloudJob>
Specifies a PSCloudJob to which this cmdlet updates the Batch service.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByValue)
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
PSCloudJob
Parameter 'Job' accepts value of type 'PSCloudJob' from the pipeline
OUTPUTS
NOTES
Example 1: Update a job
PS C:\\>$Job = Get-AzureBatchJob -Id "Job17" -BatchContext $Context
PS C:\\> $Job.Priority = 1
PS C:\\> Set-AzureBatchJob -Job $Job -BatchContext $Context
The first command gets a pool by using Get-AzureBatchJob , 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.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... rebatchjob
Disable-AzureBatchJob
Enable-AzureBatchJob
Get-AzureBatchJob
Get-AzureRmBatchAccountKeys
New-AzureBatchJob
Remove-AzureBatchJob
Stop-AzureBatchJob
Azure Batch Cmdlets