az synapse pipeline-run

Manage Synapse's pipeline run.

Commands

Name	Description	Type	Status
az synapse pipeline-run cancel	Cancel a pipeline run by its run ID.	Core	GA
az synapse pipeline-run query-by-workspace	Query pipeline runs in the workspace based on input filter conditions.	Core	GA
az synapse pipeline-run show	Get a pipeline run by its run ID.	Core	GA

az synapse pipeline-run cancel

Cancel a pipeline run by its run ID.

az synapse pipeline-run cancel --run-id
                               --workspace-name
                               [--is-recursive {false, true}]
                               [--yes]

Examples

Cancel a pipeline run by its run ID.

az synapse pipeline-run cancel --workspace-name testsynapseworkspace \
  --run-id "16ac5348-ff82-4f95-a80d-638c1d47b721"

Required Parameters

--run-id

The pipeline run identifier.

--workspace-name

The workspace name.

Optional Parameters

--is-recursive

If true, cancel all the Child pipelines that are triggered by the current pipeline.

accepted values: false, true

--yes -y

Do not prompt for confirmation.

default value: False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc

default value: json

--query

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

--subscription

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

--verbose

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

az synapse pipeline-run query-by-workspace

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

az synapse pipeline-run query-by-workspace --last-updated-after
                                           --last-updated-before
                                           --workspace-name
                                           [--continuation-token]
                                           [--filters]
                                           [--order-by]

Examples

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

az synapse pipeline-run query-by-workspace --workspace-name testsynapseworkspace --filters \
  operand="PipelineName" operator="Equals" values="testpipeline" --last-updated-after "2020-09-03T00:36:44.3345758Z" \
  --last-updated-before "2020-09-03T00:49:48.3686473Z"

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.

--workspace-name

The workspace name.

Optional Parameters

--continuation-token

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

--filters

List of filters.

--order-by

List of OrderBy option.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc

default value: json

--query

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

--subscription

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

--verbose

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

az synapse pipeline-run show

Get a pipeline run by its run ID.

az synapse pipeline-run show --run-id
                             --workspace-name

Examples

Get a pipeline run by its run ID.

az synapse pipeline-run show --workspace-name testsynapseworkspace \
  --run-id "2f7fdb90-5df1-4b8e-ac2f-064cfa58202b"

Required Parameters

--run-id

The pipeline run identifier.

--workspace-name

The workspace name.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc

default value: json

--query

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

--subscription

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

--verbose

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