DataFactoryResource.CancelPipelineRun Method

Definition

Namespace:

Azure.ResourceManager.DataFactory

Assembly:

Azure.ResourceManager.DataFactory.dll

Package:

Azure.ResourceManager.DataFactory v1.5.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 Azure.Response CancelPipelineRun (string runId, bool? isRecursive = default, System.Threading.CancellationToken cancellationToken = default);

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

Public Overridable Function CancelPipelineRun (runId As String, Optional isRecursive As Nullable(Of Boolean) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As 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

Response

Exceptions

ArgumentException

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

ArgumentNullException

runId is null.