az datafactory pipeline-run
Note
This reference is part of the datafactory extension for the Azure CLI (version 2.15.0 or higher). The extension will automatically install the first time you run an az datafactory pipeline-run command. Learn more about extensions.
Manage pipeline run with datafactory.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| az datafactory pipeline-run cancel |
Cancel a pipeline run by its run ID. |
Extension | GA |
| az datafactory pipeline-run query-by-factory |
Query pipeline runs in the factory based on input filter conditions. |
Extension | GA |
| az datafactory pipeline-run show |
Get a pipeline run by its run ID. |
Extension | GA |
az datafactory pipeline-run cancel
Cancel a pipeline run by its run ID.
az datafactory pipeline-run cancel [--factory-name]
[--ids]
[--is-recursive {false, true}]
[--resource-group]
[--run-id]
[--subscription]Examples
PipelineRuns_Cancel
az datafactory pipeline-run cancel --factory-name "exampleFactoryName" --resource-group "exampleResourceGroup" --run-id "16ac5348-ff82-4f95-a80d-638c1d47b721"Optional Parameters
The factory name.
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
If true, cancel all the Child pipelines that are triggered by the current pipeline.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
The pipeline run identifier.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az datafactory pipeline-run query-by-factory
Query pipeline runs in the factory based on input filter conditions.
az datafactory pipeline-run query-by-factory --last-updated-after
--last-updated-before
[--continuation-token]
[--factory-name]
[--filters]
[--ids]
[--order-by]
[--resource-group]
[--subscription]Examples
PipelineRuns_QueryByFactory
az datafactory pipeline-run query-by-factory --factory-name "exampleFactoryName" --filters operand="PipelineName" operator="Equals" values="examplePipeline" --last-updated-after "2018-06-16T00:36:44.3345758Z" --last-updated-before "2018-06-16T00:49:48.3686473Z" --resource-group "exampleResourceGroup"Required Parameters
The time at or after which the run event was updated in 'ISO 8601' format.
The time at or before which the run event was updated in 'ISO 8601' format.
Optional Parameters
The continuation token for getting the next page of results. Null for first page.
The factory name.
List of filters.
Usage: --filters operand=XX operator=XX values=XX
operand: Required. Parameter name to be used for filter. The allowed operands to query pipeline runs are PipelineName, RunStart, RunEnd and Status; to query activity runs are ActivityName, ActivityRunStart, ActivityRunEnd, ActivityType and Status, and to query trigger runs are TriggerName, TriggerRunTimestamp and Status. operator: Required. Operator to be used for filter. values: Required. List of filter values.
Multiple actions can be specified by using more than one --filters argument.
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
List of OrderBy option.
Usage: --order-by order-by=XX order=XX
order-by: Required. Parameter name to be used for order by. The allowed parameters to order by for pipeline runs are PipelineName, RunStart, RunEnd and Status; for activity runs are ActivityName, ActivityRunStart, ActivityRunEnd and Status; for trigger runs are TriggerName, TriggerRunTimestamp and Status. order: Required. Sorting order of the parameter.
Multiple actions can be specified by using more than one --order-by argument.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az datafactory pipeline-run show
Get a pipeline run by its run ID.
az datafactory pipeline-run show [--factory-name]
[--ids]
[--resource-group]
[--run-id]
[--subscription]Examples
PipelineRuns_Get
az datafactory pipeline-run show --factory-name "exampleFactoryName" --resource-group "exampleResourceGroup" --run-id "2f7fdb90-5df1-4b8e-ac2f-064cfa58202b"Optional Parameters
The factory name.
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
The pipeline run identifier.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for