TriggerRunOperations interface

Package:

@azure/synapse-artifacts

Interface representing a TriggerRunOperations.

Methods

cancelTriggerInstance(string, string, TriggerRunCancelTriggerInstanceOptionalParams)	Cancel single trigger instance by runId.
queryTriggerRunsByWorkspace(RunFilterParameters, TriggerRunQueryTriggerRunsByWorkspaceOptionalParams)	Query trigger runs.
rerunTriggerInstance(string, string, TriggerRunRerunTriggerInstanceOptionalParams)	Rerun single trigger instance by runId.

Method Details

cancelTriggerInstance(string, string, TriggerRunCancelTriggerInstanceOptionalParams)

Cancel single trigger instance by runId.

function cancelTriggerInstance(triggerName: string, runId: string, options?: TriggerRunCancelTriggerInstanceOptionalParams): Promise<void>

Parameters

triggerName

string

The trigger name.

runId

string

The pipeline run identifier.

options

TriggerRunCancelTriggerInstanceOptionalParams

The options parameters.

Returns

Promise<void>

queryTriggerRunsByWorkspace(RunFilterParameters, TriggerRunQueryTriggerRunsByWorkspaceOptionalParams)

Query trigger runs.

function queryTriggerRunsByWorkspace(filterParameters: RunFilterParameters, options?: TriggerRunQueryTriggerRunsByWorkspaceOptionalParams): Promise<TriggerRunsQueryResponse>

Parameters

filterParameters

RunFilterParameters

Parameters to filter the pipeline run.

options

TriggerRunQueryTriggerRunsByWorkspaceOptionalParams

The options parameters.

Returns

Promise<TriggerRunsQueryResponse>

rerunTriggerInstance(string, string, TriggerRunRerunTriggerInstanceOptionalParams)

Rerun single trigger instance by runId.

function rerunTriggerInstance(triggerName: string, runId: string, options?: TriggerRunRerunTriggerInstanceOptionalParams): Promise<void>

Parameters

triggerName

string

The trigger name.

runId

string

The pipeline run identifier.

options

TriggerRunRerunTriggerInstanceOptionalParams

The options parameters.

Returns

Promise<void>