IPipelineRunsOperations.CancelWithHttpMessagesAsync Method

Reference

Definition

Namespace:: Microsoft.Azure.Management.DataFactory

Assembly:: Microsoft.Azure.Management.DataFactory.dll

Package:: Microsoft.Azure.Management.DataFactory v8.0.0

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

CloudException

Thrown when the operation returned an invalid status code

ValidationException

Thrown when a required parameter is null

Applies to