Delen via

PipelineRunClient.CancelPipelineRunAsync Method

  • Reference

Definition

Namespace:
Azure.Analytics.Synapse.Artifacts
Assembly:
Azure.Analytics.Synapse.Artifacts.dll
Package:
Azure.Analytics.Synapse.Artifacts v1.0.0-preview.20
Source:
PipelineRunClient.cs

Cancel a pipeline run by its run ID.

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>

Applies to