pipeline_run

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

Overview

Name	pipeline_run
Type	Resource
Id	azure.synapse_artifacts.pipeline_run

Fields

The following fields are returned by SELECT queries:

query_activity_runs

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 activity runs. Required.

query_pipeline_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 pipeline runs. Required.

get_pipeline_run

Name	Datatype	Description
	object	Unmatched properties from the message are deserialized to this collection.
durationInMs	integer	The duration of a pipeline run.
invokedBy	object	Entity that started the pipeline run.
isLatest	boolean	Indicates if the recovered pipeline run is the latest in its group.
lastUpdated	string (date-time)	The last updated timestamp for the pipeline run event in ISO8601 format.
message	string	The message from a pipeline run.
parameters	object	The full or partial list of parameter name, value pair used in the pipeline run.
pipelineName	string	The pipeline name.
runEnd	string (date-time)	The end time of a pipeline run in ISO8601 format.
runGroupId	string	Identifier that correlates all the recovery runs of a pipeline run.
runId	string	Identifier of a run.
runStart	string (date-time)	The start time of a pipeline run in ISO8601 format.
status	string	The status of a pipeline run.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
query_activity_runs	select	pipeline_name, run_id, endpoint		Query activity runs based on input filter conditions.
query_pipeline_runs_by_workspace	select	endpoint		Query pipeline runs in the workspace based on input filter conditions.
get_pipeline_run	select	run_id, endpoint		Get a pipeline run by its run ID.
cancel_pipeline_run	exec	run_id, endpoint	isRecursive	Cancel a pipeline run by its run ID.

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: )
pipeline_name	string	The pipeline name. Required.
run_id	string	The pipeline run identifier. Required.
isRecursive	boolean	If true, cancel all the Child pipelines that are triggered by the current pipeline. Default value is None.

SELECT examples

query_activity_runs

Query activity runs based on input filter conditions.

SELECT
continuationToken,
value
FROM azure.synapse_artifacts.pipeline_run
WHERE pipeline_name = '{{ pipeline_name }}' -- required
AND run_id = '{{ run_id }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;

query_pipeline_runs_by_workspace

Query pipeline runs in the workspace based on input filter conditions.

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

get_pipeline_run

Get a pipeline run by its run ID.

SELECT
,
durationInMs,
invokedBy,
isLatest,
lastUpdated,
message,
parameters,
pipelineName,
runEnd,
runGroupId,
runId,
runStart,
status
FROM azure.synapse_artifacts.pipeline_run
WHERE run_id = '{{ run_id }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;

Lifecycle Methods

cancel_pipeline_run

Cancel a pipeline run by its run ID.

EXEC azure.synapse_artifacts.pipeline_run.cancel_pipeline_run 
@run_id='{{ run_id }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@isRecursive={{ isRecursive }}
;