CloudJob.DisableAsync(DisableJobOption, IEnumerable<BatchClientBehavior>, CancellationToken) Method

Definition

Disables this CloudJob. Disabled jobs do not run new tasks, but may be re-enabled later.

public System.Threading.Tasks.Task DisableAsync (Microsoft.Azure.Batch.Common.DisableJobOption disableJobOption, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default, System.Threading.CancellationToken cancellationToken = default);
member this.DisableAsync : Microsoft.Azure.Batch.Common.DisableJobOption * seq<Microsoft.Azure.Batch.BatchClientBehavior> * System.Threading.CancellationToken -> System.Threading.Tasks.Task
Public Function DisableAsync (disableJobOption As DisableJobOption, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task

Parameters

disableJobOption
DisableJobOption

Specifies what to do with active tasks associated with the job.

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 disable operation runs asynchronously.

Applies to