JobScheduleOperations.TerminateJobSchedule Method

Definition

Namespace:

Microsoft.Azure.Batch

Assembly:

Microsoft.Azure.Batch.dll

Package:

Microsoft.Azure.Batch v16.2.0

Source:

JobScheduleOperations.cs

Terminates the specified job schedule.

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

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

Public Sub TerminateJobSchedule (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 terminate operation requests that the job schedule be terminated. The request puts the schedule in the Terminating state. The Batch service will wait for any active job to terminate, and perform the actual job schedule termination without any further client action.

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