Stop-​Azure​Batch​Job

Stops a Batch job.

Syntax

Stop-AzureBatchJob
    [-Id] <String>
    [[-TerminateReason] <String>]
    -BatchContext <BatchAccountContext>
    [<CommonParameters>]

Description

The Stop-AzureBatchJob cmdlet stops an Azure Batch job. This command marks the job as completed.

Examples

Example 1: Stop a Batch job

PS C:\>Stop-AzureBatchJob -Id "Job-000001" -TerminateReason "No more tasks to run" -BatchContext $Context

This command stops the job that has the ID Job-000001. The command specifies a reason that you chose to stop 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
-Id

Specifies the ID of the job that this cmdlet stops.

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

Optional Parameters

-TerminateReason

Specifies the reason that you decided to stop the job. This cmdlet stores this text as the TerminateReason property of the job.

Type:String
Position:1
Default value:None
Accept pipeline input:False
Accept wildcard characters:False