JobScheduleOperations.DeleteJobScheduleAsync(String, IEnumerable<BatchClientBehavior>, CancellationToken) Method

Definition

Deletes the specified job schedule.

public System.Threading.Tasks.Task DeleteJobScheduleAsync (string jobScheduleId, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = null, System.Threading.CancellationToken cancellationToken = null);
member this.DeleteJobScheduleAsync : string * seq<Microsoft.Azure.Batch.BatchClientBehavior> * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Parameters

jobScheduleId
System.String

The id of the job schedule.

additionalBehaviors
System.Collections.Generic.IEnumerable<BatchClientBehavior>

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

cancellationToken
System.Threading.CancellationToken

A System.Threading.CancellationToken for controlling the lifetime of the asynchronous operation.

Returns

System.Threading.Tasks.Task

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

Applies to