IPipelineRunsOperations.CancelWithHttpMessagesAsync(String, String, String, Nullable<Boolean>, Dictionary<String,List<String>>, CancellationToken) Method

Definition

Cancel a pipeline run by its run ID.

public System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse> CancelWithHttpMessagesAsync (string resourceGroupName, string factoryName, string runId, bool? isRecursive = default, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);
abstract member CancelWithHttpMessagesAsync : string * string * string * Nullable<bool> * 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, factoryName As String, runId As String, Optional isRecursive As Nullable(Of Boolean) = Nothing, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AzureOperationResponse)

Parameters

resourceGroupName
String

The resource group name.

factoryName
String

The factory name.

runId
String

The pipeline run identifier.

isRecursive
Nullable<Boolean>

If true, cancel all the Child pipelines that are triggered by the current pipeline.

customHeaders
Dictionary<String,List<String>>

The headers that will be added to request.

cancellationToken
CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse>

Exceptions

Thrown when the operation returned an invalid status code

Thrown when a required parameter is null

Applies to