Disable-AzBatchJob

Disables a Batch job.

Syntax

Disable-AzBatchJob
       [-Id] <String>
       [-DisableJobOption] <DisableJobOption>
       -BatchContext <BatchAccountContext>
       [-DefaultProfile <IAzureContextContainer>]
       [<CommonParameters>]

Description

The Disable-AzBatchJob 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-AzBatchJob -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-AzBatchAccountKey cmdlet to assign a context to the $Context variable.

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 Azure Active Directory 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
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
-DefaultProfile

The credentials, account, tenant, and subscription used for communication with azure.

Type:Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Accept pipeline input:False
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
Accepted values: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

Inputs

String

BatchAccountContext

Outputs

Void