JobOperations.DeleteJobAsync Method (String, IEnumerable<BatchClientBehavior>)

 

Deletes the specified job.

Namespace:   Microsoft.Azure.Batch
Assembly:  Microsoft.Azure.Batch (in Microsoft.Azure.Batch.dll)

Syntax

public Task DeleteJobAsync(
    string jobId,
    IEnumerable<BatchClientBehavior> additionalBehaviors = null
)

public:
Task^ DeleteJobAsync(
    String^ jobId,
    IEnumerable<BatchClientBehavior^>^ additionalBehaviors = null
)

member DeleteJobAsync : 
        jobId:string *
        additionalBehaviors:IEnumerable<BatchClientBehavior> = null -> Task

Public Function DeleteJobAsync (
    jobId As String,
    additionalBehaviors As IEnumerable(Of BatchClientBehavior)
) As Task

Parameters

• jobId
  Type: System.String

  The id of the job.

• additionalBehaviors
  Type: System.Collections.Generic.IEnumerable<BatchClientBehavior>

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

Return Value

Type: System.Threading.Tasks.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.

See Also

JobOperations Class
Microsoft.Azure.Batch Namespace

Return to top