DataFactoryResource.CancelPipelineRunAsync Method

Definition

Namespace:

Azure.ResourceManager.DataFactory

Assembly:

Azure.ResourceManager.DataFactory.dll

Package:

Azure.ResourceManager.DataFactory v1.6.0

Source:

DataFactoryResource.cs

Cancel a pipeline run by its run ID.

• Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelineruns/{runId}/cancel
• Operation Id: PipelineRuns_Cancel
• Default Api Version: 2018-06-01

public virtual System.Threading.Tasks.Task<Azure.Response> CancelPipelineRunAsync (string runId, bool? isRecursive = default, System.Threading.CancellationToken cancellationToken = default);

abstract member CancelPipelineRunAsync : string * Nullable<bool> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
override this.CancelPipelineRunAsync : string * Nullable<bool> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>

Public Overridable Function CancelPipelineRunAsync (runId As String, Optional isRecursive As Nullable(Of Boolean) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response)

Parameters

runId

String

The pipeline run identifier.

isRecursive

Nullable<Boolean>

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

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Task<Response>

Exceptions

ArgumentException

runId is an empty string, and was expected to be non-empty.

ArgumentNullException

runId is null.