JobOperations.DeleteJob 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 void DeleteJob (string jobId, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default);

member this.DeleteJob : string * seq<Microsoft.Azure.Batch.BatchClientBehavior> -> unit

Public Sub DeleteJob (jobId As String, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing)

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.

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.

This is a blocking operation. For a non-blocking equivalent, see DeleteJobAsync(String, IEnumerable<BatchClientBehavior>, CancellationToken).