JobOperations.DeleteJobAsync Method

Definition

Namespace:

Microsoft.Azure.Batch

Assembly:

Microsoft.Azure.Batch.dll

Package:

Microsoft.Azure.Batch v16.2.0

Source:

JobOperations.cs

Deletes the specified job.

public System.Threading.Tasks.Task DeleteJobAsync (string jobId, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default, System.Threading.CancellationToken cancellationToken = default);

member this.DeleteJobAsync : string * seq<Microsoft.Azure.Batch.BatchClientBehavior> * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Function DeleteJobAsync (jobId As String, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task

Parameters

jobId

String

The id of the job.

additionalBehaviors

IEnumerable<BatchClientBehavior>

A collection of BatchClientBehavior instances that are applied to the Batch service request after the CustomBehaviors.

cancellationToken

CancellationToken

A CancellationToken for controlling the lifetime of the asynchronous operation.

Returns

Task

A Task that represents the asynchronous operation.

Remarks

The delete operation requests that the job be deleted. The request puts the job in the Deleting state. The Batch service will stop any running tasks and perform the actual job deletion without any further client action.

The delete operation runs asynchronously.