Share via


IJobExecutionsOperations.CancelWithHttpMessagesAsync Method

Definition

Requests cancellation of a job execution.

public System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse> CancelWithHttpMessagesAsync (string resourceGroupName, string serverName, string jobAgentName, string jobName, Guid jobExecutionId, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);
abstract member CancelWithHttpMessagesAsync : string * string * string * string * Guid * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse>
Public Function CancelWithHttpMessagesAsync (resourceGroupName As String, serverName As String, jobAgentName As String, jobName As String, jobExecutionId As Guid, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AzureOperationResponse)

Parameters

resourceGroupName
String

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serverName
String

The name of the server.

jobAgentName
String

The name of the job agent.

jobName
String

The name of the job.

jobExecutionId
Guid

The id of the job execution to cancel.

customHeaders
Dictionary<String,List<String>>

The headers that will be added to request.

cancellationToken
CancellationToken

The cancellation token.

Returns

Exceptions

Thrown when the operation returned an invalid status code

Thrown when a required parameter is null

Applies to