Stop-AzBatchTask

Reference

Module:: Az.Batch

Stops a Batch task.

Syntax

Stop-AzBatchTask
    [-JobId] <String>
    [-Id] <String>
    -BatchContext <BatchAccountContext>
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

Stop-AzBatchTask
    [-Task] <PSCloudTask>
    -BatchContext <BatchAccountContext>
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

Description

The Stop-AzBatchTask cmdlet stops an Azure Batch task.

Examples

Example 1: Delete a Batch task by ID

Stop-AzBatchTask -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-AzBatchAccountKey cmdlet to assign a context to the $Context variable.

Example 2: Stop a Batch task by using the pipeline

Get-AzBatchTask -JobId "Job-000001" -Id "Task26" -BatchContext $Context | Stop-AzBatchTask -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-AzBatchTask cmdlet. The command passes that task to the current cmdlet by using the pipeline operator. The command stops that task.

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 Microsoft Entra 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
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-DefaultProfile

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

Type:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Id

Specifies the ID of the task that this cmdlet stops.

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

-JobId

Specifies the ID of the job that contains the task.

Type:	String
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Task

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

Type:	PSCloudTask
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

Inputs

String

PSCloudTask

BatchAccountContext

Outputs

Void