JobScheduleOperations.DisableJobSchedule Method

Definition

Namespace:

Microsoft.Azure.Batch

Assembly:

Microsoft.Azure.Batch.dll

Package:

Microsoft.Azure.Batch v16.2.0

Source:

JobScheduleOperations.cs

Disables the specified job schedule. Disabled schedules do not create new jobs, but may be re-enabled later.

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

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

Public Sub DisableJobSchedule (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

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

To re-enable the schedule, call EnableJobSchedule(String, IEnumerable<BatchClientBehavior>).