trigger_run

Creates, updates, deletes, gets or lists a trigger_run resource.

Overview

Name	trigger_run
Type	Resource
Id	azure.synapse_artifacts.trigger_run

Fields

The following fields are returned by SELECT queries:

query_trigger_runs_by_workspace

Name	Datatype	Description
continuationToken	string	The continuation token for getting the next page of results, if any remaining results exist, null otherwise.
value	array	List of trigger runs. Required.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
query_trigger_runs_by_workspace	select	endpoint		Query trigger runs.
rerun_trigger_instance	exec	trigger_name, run_id, endpoint		Rerun single trigger instance by runId.
cancel_trigger_instance	exec	trigger_name, run_id, endpoint		Cancel single trigger instance by runId.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
endpoint	string	The service endpoint host (no scheme). (default: )
run_id	string	The pipeline run identifier. Required.
trigger_name	string	The trigger name. Required.

SELECT examples

query_trigger_runs_by_workspace

Query trigger runs.

SELECT
continuationToken,
value
FROM azure.synapse_artifacts.trigger_run
WHERE endpoint = '{{ endpoint }}' -- required
;

Lifecycle Methods

rerun_trigger_instance

Rerun single trigger instance by runId.

EXEC azure.synapse_artifacts.trigger_run.rerun_trigger_instance 
@trigger_name='{{ trigger_name }}' --required, 
@run_id='{{ run_id }}' --required, 
@endpoint='{{ endpoint }}' --required
;

cancel_trigger_instance

Cancel single trigger instance by runId.

EXEC azure.synapse_artifacts.trigger_run.cancel_trigger_instance 
@trigger_name='{{ trigger_name }}' --required, 
@run_id='{{ run_id }}' --required, 
@endpoint='{{ endpoint }}' --required
;