az datafactory activity-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 activity-run command. Learn more about extensions.

Manage activity run with datafactory.

Commands

Name	Description	Type	Status
az datafactory activity-run query-by-pipeline-run	Query activity runs based on input filter conditions.	Extension	GA

az datafactory activity-run query-by-pipeline-run

Query activity runs based on input filter conditions.

az datafactory activity-run query-by-pipeline-run --last-updated-after
                                                  --last-updated-before
                                                  [--continuation-token]
                                                  [--factory-name]
                                                  [--filters]
                                                  [--ids]
                                                  [--order-by]
                                                  [--resource-group]
                                                  [--run-id]
                                                  [--subscription]

Examples

ActivityRuns_QueryByPipelineRun

az datafactory activity-run query-by-pipeline-run --factory-name "exampleFactoryName" --last-updated-after "2018-06-16T00:36:44.3345758Z" --last-updated-before "2018-06-16T00:49:48.3686473Z" --resource-group "exampleResourceGroup" --run-id "2f7fdb90-5df1-4b8e-ac2f-064cfa58202b"

Required Parameters

--last-updated-after

The time at or after which the run event was updated in 'ISO 8601' format.

--last-updated-before

The time at or before which the run event was updated in 'ISO 8601' format.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--continuation-token

The continuation token for getting the next page of results. Null for first page.

--factory-name

The factory name.

Property	Value
Parameter group:	Resource Id Arguments

--filters

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.

--ids

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.

Property	Value
Parameter group:	Resource Id Arguments

--order-by

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.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property	Value
Parameter group:	Resource Id Arguments

--run-id

The pipeline run identifier.

Property	Value
Parameter group:	Resource Id Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False