JobOperations.DisableJob Method

  • Reference

Definition

Namespace:
Microsoft.Azure.Batch
Assembly:
Microsoft.Azure.Batch.dll
Package:
Microsoft.Azure.Batch v16.2.0
Source:
JobOperations.cs

Disables the specified job. Disabled jobs do not run new tasks, but may be re-enabled later.

public void DisableJob (string jobId, Microsoft.Azure.Batch.Common.DisableJobOption disableJobOption, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default);
member this.DisableJob : string * Microsoft.Azure.Batch.Common.DisableJobOption * seq<Microsoft.Azure.Batch.BatchClientBehavior> -> unit
Public Sub DisableJob (jobId As String, disableJobOption As DisableJobOption, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing)

Parameters

jobId
String

The id of the job.

disableJobOption
DisableJobOption

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

additionalBehaviors
IEnumerable<BatchClientBehavior>

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

Remarks

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

Applies to