IJobScheduleOperations.DisableWithHttpMessagesAsync Method

Definition

Disables a Job Schedule.

public System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationHeaderResponse<Microsoft.Azure.Batch.Protocol.Models.JobScheduleDisableHeaders>> DisableWithHttpMessagesAsync (string jobScheduleId, Microsoft.Azure.Batch.Protocol.Models.JobScheduleDisableOptions jobScheduleDisableOptions = default, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);
abstract member DisableWithHttpMessagesAsync : string * Microsoft.Azure.Batch.Protocol.Models.JobScheduleDisableOptions * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationHeaderResponse<Microsoft.Azure.Batch.Protocol.Models.JobScheduleDisableHeaders>>
Public Function DisableWithHttpMessagesAsync (jobScheduleId As String, Optional jobScheduleDisableOptions As JobScheduleDisableOptions = Nothing, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AzureOperationHeaderResponse(Of JobScheduleDisableHeaders))

Parameters

jobScheduleId
System.String

The ID of the Job Schedule to disable.

jobScheduleDisableOptions
JobScheduleDisableOptions

Additional parameters for the operation

customHeaders
System.Collections.Generic.Dictionary<System.String,System.Collections.Generic.List<System.String>>

The headers that will be added to request.

cancellationToken
System.Threading.CancellationToken

The cancellation token.

Returns

System.Threading.Tasks.Task<AzureOperationHeaderResponse<JobScheduleDisableHeaders>>

Exceptions

Thrown when the operation returned an invalid status code

Thrown when a required parameter is null

Remarks

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

Applies to