IJobScheduleOperations.TerminateWithHttpMessagesAsync(String, JobScheduleTerminateOptions, Dictionary<String,List<String>>, CancellationToken) Method

Definition

Terminates a job schedule.

public System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationHeaderResponse<Microsoft.Azure.Batch.Protocol.Models.JobScheduleTerminateHeaders>> TerminateWithHttpMessagesAsync (string jobScheduleId, Microsoft.Azure.Batch.Protocol.Models.JobScheduleTerminateOptions jobScheduleTerminateOptions = null, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = null, System.Threading.CancellationToken cancellationToken = null);
abstract member TerminateWithHttpMessagesAsync : string * Microsoft.Azure.Batch.Protocol.Models.JobScheduleTerminateOptions * 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.JobScheduleTerminateHeaders>>

Parameters

jobScheduleId
System.String

The ID of the job schedule to terminates.

jobScheduleTerminateOptions
JobScheduleTerminateOptions

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<Microsoft.Rest.Azure.AzureOperationHeaderResponse<JobScheduleTerminateHeaders>>

Exceptions

Thrown when the operation returned an invalid status code

Thrown when a required parameter is null

Applies to