DataFactoryTriggerResource.CancelTriggerRunAsync Method

Reference

Definition

Namespace:: Azure.ResourceManager.DataFactory

Assembly:: Azure.ResourceManager.DataFactory.dll

Package:: Azure.ResourceManager.DataFactory v1.6.0

Package:: Azure.ResourceManager.DataFactory v1.0.0-beta.6

Source:: DataFactoryTriggerResource.cs

Source:: DataFactoryTriggerResource.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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.

Applies to

Share via