JobScheduleOperations.TerminateJobScheduleAsync Method

Reference

Definition

Namespace:: Microsoft.Azure.Batch

Assembly:: Microsoft.Azure.Batch.dll

Package:: Microsoft.Azure.Batch v16.2.0

Source:: JobScheduleOperations.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Terminates the specified job schedule.

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

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

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

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.

cancellationToken: CancellationToken

A CancellationToken for controlling the lifetime of the asynchronous operation.

Returns

Task

A Task that represents the asynchronous operation.

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.

The terminate operation runs asynchronously.

Applies to