Disable-​Azure​Batch​Job

Disables a Batch job.

Syntax

Disable-AzureBatchJob
       [-Id] <String>
       [-DisableJobOption] <DisableJobOption>
       -BatchContext <BatchAccountContext>
       [<CommonParameters>]

Description

The Disable-AzureBatchJob cmdlet disables an Azure Batch job. After you enable a job, new tasks can run. Disabled jobs do not run new tasks. You can enable a disabled job later.

Examples

Example 1: Disable a Batch job

PS C:\>Disable-AzureBatchJob -Id "Job-000001" -DisableJobOption "Terminate" -BatchContext $Context

This command disables the job that has the ID Job-000001. The command terminates active tasks for the job. Use the Get-AzureRmBatchAccountKeys cmdlet to assign a context to the $Context variable.

Required Parameters

-BatchContext

Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. To obtain a BatchAccountContext object that contains access keys for your subscription, use the Get-AzureRmBatchAccountKeys cmdlet.

Type:BatchAccountContext
Position:Named
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
-DisableJobOption

Specifies what to do with active tasks associated with the job that this cmdlet disables. Valid values are:

  • Requeue
  • Terminate
  • Wait
Type:DisableJobOption
Parameter Sets:Requeue, Terminate, Wait
Position:1
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Id

Specifies the ID of the job that this cmdlet disables.

Type:String
Position:0
Default value:None
Accept pipeline input:True (ByPropertyName, ByValue)
Accept wildcard characters:False