Partilhar via


DataFactoryTriggerResource.CancelTriggerRun(String, CancellationToken) Method

Definition

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 Azure.Response CancelTriggerRun (string runId, System.Threading.CancellationToken cancellationToken = default);
abstract member CancelTriggerRun : string * System.Threading.CancellationToken -> Azure.Response
override this.CancelTriggerRun : string * System.Threading.CancellationToken -> Azure.Response
Public Overridable Function CancelTriggerRun (runId As String, Optional cancellationToken As CancellationToken = Nothing) As Response

Parameters

runId
String

The pipeline run identifier.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

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

runId is null.

Applies to