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:

get

OK.

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
get	select	subscriptionId, resourceGroupName, factoryName, runId	api-version	Get a pipeline run by its run ID.
query_by_factory	exec	subscriptionId, resourceGroupName, factoryName, lastUpdatedAfter, lastUpdatedBefore	api-version	Query pipeline runs in the factory based on input filter conditions.
cancel	exec	subscriptionId, resourceGroupName, factoryName, runId	isRecursive, api-version	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
factoryName	string	The factory name.
resourceGroupName	string	The resource group name.
runId	string	The pipeline run identifier.
subscriptionId	string	The subscription identifier.
api-version	string	The API version.
isRecursive	boolean	If true, cancel all the Child pipelines that are triggered by the current pipeline.

SELECT examples

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 subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND factoryName = '{{ factoryName }}' -- required
AND runId = '{{ runId }}' -- required
AND api-version = '{{ api-version }}'
;

Lifecycle Methods

query_by_factory

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

EXEC azure.data_factory.pipeline_runs.query_by_factory 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@factoryName='{{ factoryName }}' --required, 
@api-version='{{ api-version }}' 
@@json=
'{
"continuationToken": "{{ continuationToken }}", 
"lastUpdatedAfter": "{{ lastUpdatedAfter }}", 
"lastUpdatedBefore": "{{ lastUpdatedBefore }}", 
"filters": "{{ filters }}", 
"orderBy": "{{ orderBy }}"
}'
;

cancel

Cancel a pipeline run by its run ID.

EXEC azure.data_factory.pipeline_runs.cancel 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@factoryName='{{ factoryName }}' --required, 
@runId='{{ runId }}' --required, 
@isRecursive={{ isRecursive }}, 
@api-version='{{ api-version }}'
;