DataFactoryTriggerResource.CancelTriggerRunAsync Method

Definition

Namespace:

Azure.ResourceManager.DataFactory

Assembly:

Azure.ResourceManager.DataFactory.dll

Package:

Azure.ResourceManager.DataFactory v1.5.0

Source:

DataFactoryTriggerResource.cs

Cancel a single trigger instance by runId.

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

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

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

Public Overridable Function CancelTriggerRunAsync (runId As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response)

Parameters

runId

String

The pipeline run identifier.

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.