JobOperations.DisableJobAsync Method (String, DisableJobOption, IEnumerable<BatchClientBehavior>)

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

Namespace:   Microsoft.Azure.Batch
Assembly:  Microsoft.Azure.Batch (in Microsoft.Azure.Batch.dll)

Syntax

public Task DisableJobAsync(
    string jobId,
    DisableJobOption disableJobOption,
    IEnumerable<BatchClientBehavior> additionalBehaviors = null
)

public:
Task^ DisableJobAsync(
    String^ jobId,
    DisableJobOption disableJobOption,
    IEnumerable<BatchClientBehavior^>^ additionalBehaviors = null
)

member DisableJobAsync : 
        jobId:string *
        disableJobOption:DisableJobOption *
        additionalBehaviors:IEnumerable<BatchClientBehavior> = null -> Task

Public Function DisableJobAsync (
    jobId As String,
    disableJobOption As DisableJobOption,
    additionalBehaviors As IEnumerable(Of BatchClientBehavior)
) As Task

Parameters

• jobId
  Type: System.String

  The id of the job.

• disableJobOption
  Type: Microsoft.Azure.Batch.Common.DisableJobOption

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

• additionalBehaviors
  Type: System.Collections.Generic.IEnumerable<BatchClientBehavior>

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

Return Value

Type: System.Threading.Tasks.Task

A Task that represents the asynchronous operation.

Remarks

The disable operation runs asynchronously.

See Also

JobOperations Class
Microsoft.Azure.Batch Namespace

Return to top