Stop-​Azure​Batch​Task

Stops a Batch task.

Syntax

Stop-AzureBatchTask
    [-JobId] <String>
    [-Id] <String>
    -BatchContext <BatchAccountContext>
    [<CommonParameters>]
Stop-AzureBatchTask
    [-Task] <PSCloudTask>
    -BatchContext <BatchAccountContext>
    [<CommonParameters>]

Description

The Stop-AzureBatchTask cmdlet stops an Azure Batch task.

Examples

Example 1: Delete a Batch task by ID

PS C:\>Stop-AzureBatchTask -JobId "Job-000001" -Id "Task23" -BatchContext $Context

This command stops a task that has the ID Task23 under the job that has the ID Job-000001. The command prompts you for confirmation. Use the Get-AzureRmBatchAccountKeys cmdlet to assign a context to the $Context variable.

Example 2: Stop a Batch task by using the pipeline

PS C:\>Get-AzureBatchTask -JobId "Job-000001" -Id "Task26" -BatchContext $Context | Stop-AzureBatchTask -BatchContext $Context

This command gets the Batch task that has the ID Task26 in the job that has the ID Job-000001 by using the Get-AzureBatchTask cmdlet. The command passes that task to the current cmdlet by using the pipeline operator. The command stops that task.

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 task that this cmdlet stops.

Type:String
Position:1
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-JobId

Specifies the ID of the job that contains the task.

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

Specifies the task that this cmdlet stops. To obtain a PSCloudTask object, use the Get-AzureBatchTask cmdlet.

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