PipelineRunsOperationsExtensions.CancelAsync Method

Definition

Namespace:

Microsoft.Azure.Management.DataFactory

Assembly:

Microsoft.Azure.Management.DataFactory.dll

Package:

Microsoft.Azure.Management.DataFactory v8.0.0

Cancel a pipeline run by its run ID.

public static System.Threading.Tasks.Task CancelAsync (this Microsoft.Azure.Management.DataFactory.IPipelineRunsOperations operations, string resourceGroupName, string factoryName, string runId, bool? isRecursive = default, System.Threading.CancellationToken cancellationToken = default);

static member CancelAsync : Microsoft.Azure.Management.DataFactory.IPipelineRunsOperations * string * string * string * Nullable<bool> * System.Threading.CancellationToken -> System.Threading.Tasks.Task

<Extension()>
Public Function CancelAsync (operations As IPipelineRunsOperations, resourceGroupName As String, factoryName As String, runId As String, Optional isRecursive As Nullable(Of Boolean) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task

Parameters

operations

IPipelineRunsOperations

The operations group for this extension method.

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.

cancellationToken

CancellationToken

The cancellation token.

Returns

Task