pipeline_runs

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

Overview

Name	pipeline_runs
Type	Resource
Id	azure.data_factory.pipeline_runs

Fields

The following fields are returned by SELECT queries:

query_by_factory

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

Name	Datatype	Description
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.
runDimensions	object	Run dimensions emitted by Pipeline run.
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. Possible values: Queued, InProgress, Succeeded, Failed, Canceling, Cancelled.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
query_by_factory	select	resource_group_name, factory_name, subscription_id		Query pipeline runs in the factory based on input filter conditions.
get	select	resource_group_name, factory_name, run_id, subscription_id		Get a pipeline run by its run ID.
cancel	exec	resource_group_name, factory_name, run_id, subscription_id	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
factory_name	string	Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
run_id	string	The pipeline run identifier. Required.
subscription_id	string
isRecursive	boolean	If true, cancel all the Child pipelines that are triggered by the current pipeline. Default value is None.

SELECT examples

query_by_factory

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

SELECT
continuationToken,
value
FROM azure.data_factory.pipeline_runs
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND factory_name = '{{ factory_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get

Get a pipeline run by its run ID.

SELECT
durationInMs,
invokedBy,
isLatest,
lastUpdated,
message,
parameters,
pipelineName,
runDimensions,
runEnd,
runGroupId,
runId,
runStart,
status
FROM azure.data_factory.pipeline_runs
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND factory_name = '{{ factory_name }}' -- required
AND run_id = '{{ run_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

Lifecycle Methods

cancel

Cancel a pipeline run by its run ID.

EXEC azure.data_factory.pipeline_runs.cancel 
@resource_group_name='{{ resource_group_name }}' --required, 
@factory_name='{{ factory_name }}' --required, 
@run_id='{{ run_id }}' --required, 
@subscription_id='{{ subscription_id }}' --required, 
@isRecursive={{ isRecursive }}
;