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

Name	Datatype	Description
durationInMs	integer	The duration of a pipeline run.
invokedBy	object	Provides entity name and id that started the pipeline run.
isLatest	boolean	Indicates if the recovered pipeline run is the latest in its group.
lastUpdated	string	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	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	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

Name	Accessible by	Required Params	Description
get	SELECT	factoryName, resourceGroupName, runId, subscriptionId	Get a pipeline run by its run ID.
cancel	EXEC	factoryName, resourceGroupName, runId, subscriptionId	Cancel a pipeline run by its run ID.
query_by_factory	EXEC	factoryName, resourceGroupName, subscriptionId, data__lastUpdatedAfter, data__lastUpdatedBefore	Query pipeline runs in the factory based on input filter conditions.

SELECT examples

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