CloudJobSchedule.DeleteAsync Method

Definition

Namespace:

Microsoft.Azure.Batch

Assembly:

Microsoft.Azure.Batch.dll

Package:

Microsoft.Azure.Batch v16.2.0

Source:

CloudJobSchedule.cs

Deletes this CloudJobSchedule.

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

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

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

Parameters

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 schedule be deleted. The request puts the schedule in the Deleting state. The Batch service will delete any existing jobs and tasks under the schedule, including any active job, and perform the actual job schedule deletion without any further client action.

The delete operation runs asynchronously.