JobScheduleOperations.DeleteJobSchedule Method

Definition

Namespace:

Microsoft.Azure.Batch

Assembly:

Microsoft.Azure.Batch.dll

Package:

Microsoft.Azure.Batch v16.2.0

Source:

JobScheduleOperations.cs

Deletes the specified job schedule.

public void DeleteJobSchedule (string jobScheduleId, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default);

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

Public Sub DeleteJobSchedule (jobScheduleId As String, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing)

Parameters

jobScheduleId

String

The id of the job schedule.

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 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.

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