JobScheduleOperationsExtensions.DisableAsync Method

Definition

Disables a Job Schedule.

public static System.Threading.Tasks.Task<Microsoft.Azure.Batch.Protocol.Models.JobScheduleDisableHeaders> DisableAsync (this Microsoft.Azure.Batch.Protocol.IJobScheduleOperations operations, string jobScheduleId, Microsoft.Azure.Batch.Protocol.Models.JobScheduleDisableOptions jobScheduleDisableOptions = default, System.Threading.CancellationToken cancellationToken = default);
static member DisableAsync : Microsoft.Azure.Batch.Protocol.IJobScheduleOperations * string * Microsoft.Azure.Batch.Protocol.Models.JobScheduleDisableOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Batch.Protocol.Models.JobScheduleDisableHeaders>
<Extension()>
Public Function DisableAsync (operations As IJobScheduleOperations, jobScheduleId As String, Optional jobScheduleDisableOptions As JobScheduleDisableOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of JobScheduleDisableHeaders)

Parameters

operations
IJobScheduleOperations

The operations group for this extension method.

jobScheduleId
System.String

The ID of the Job Schedule to disable.

jobScheduleDisableOptions
JobScheduleDisableOptions

Additional parameters for the operation

cancellationToken
System.Threading.CancellationToken

The cancellation token.

Returns

System.Threading.Tasks.Task<JobScheduleDisableHeaders>

Remarks

No new Jobs will be created until the Job Schedule is enabled again.

Applies to