Share via

az synapse pipeline

  • Reference

Manage Synapse's pipelines.

Commands

Name Description Type Status
az synapse pipeline create

Create a pipeline.

 Core GA
az synapse pipeline create-run

Creates a run of a pipeline.

 Core GA
az synapse pipeline delete

Delete a pipeline.

 Core GA
az synapse pipeline list

List pipelines.

 Core GA
az synapse pipeline set

Update an exist pipeline.

 Core Deprecated
az synapse pipeline show

Get a pipeline.

 Core GA
az synapse pipeline update

Update an exist pipeline.

 Core GA

az synapse pipeline create

Edit

Create a pipeline.

az synapse pipeline create --file
                           --name
                           --workspace-name
                           [--no-wait]

Examples

Create a pipeline. Pay attention to add "@" at the front of the file path as the best practice for complex arguments like JSON string.

az synapse pipeline create --workspace-name testsynapseworkspace \
  --name testpipeline --file @"path/pipeline.json"

Required Parameters

--file

Properties may be supplied from a JSON file using the @{path} syntax or a JSON string.

--name -n

The pipeline name.

--workspace-name

The workspace name.

Optional Parameters

--no-wait

Do not wait for the long-running operation to finish.

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 create-run

Edit

Creates a run of a pipeline.

az synapse pipeline create-run --name
                               --workspace-name
                               [--is-recovery {false, true}]
                               [--parameters]
                               [--reference-pipeline-run-id]
                               [--start-activity-name]

Examples

Pipelines_CreateRun

az synapse pipeline create-run --workspace-name testsynapseworkspace --name "myPipeline" \
  --parameters "{\"OutputBlobNameList\":[\"exampleoutput.csv\"]}"

Required Parameters

--name -n

The pipeline name.

--workspace-name

The workspace name.

Optional Parameters

--is-recovery

Recovery mode flag. If recovery mode is set to true, the specified referenced pipeline run and the new run will be grouped under the same groupId.

Accepted values: false, true
--parameters

Parameters for pipeline run. Can be supplied from a JSON file using the @{path} syntax or a JSON string.

--reference-pipeline-run-id --run-id

The pipeline run ID for rerun. If run ID is specified, the parameters of the specified run will be used to create a new run.

--start-activity-name

In recovery mode, the rerun will start from this activity. If not specified, all activities will run.

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 delete

Edit

Delete a pipeline.

az synapse pipeline delete --name
                           --workspace-name
                           [--no-wait]
                           [--yes]

Examples

Delete a pipeline.

az synapse pipeline delete --workspace-name testsynapseworkspace \
  --name testpipeline

Required Parameters

--name -n

The pipeline name.

--workspace-name

The workspace name.

Optional Parameters

--no-wait

Do not wait for the long-running operation to finish.

Default value: False
--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 list

Edit

List pipelines.

az synapse pipeline list --workspace-name

Examples

List pipelines.

az synapse pipeline list --workspace-name testsynapseworkspace

Required Parameters

--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.

az synapse pipeline set

Edit
Deprecated

This command has been deprecated and will be removed in a future release. Use 'update' instead.

Update an exist pipeline.

az synapse pipeline set --file
                        --name
                        --workspace-name
                        [--no-wait]

Examples

Update an exist pipeline. Pay attention to add "@" at the front of the file path as the best practice for complex arguments like JSON string.

az synapse pipeline set --workspace-name testsynapseworkspace \
  --name testpipeline --file @"path/pipeline.json"

Required Parameters

--file

Properties may be supplied from a JSON file using the @{path} syntax or a JSON string.

--name -n

The pipeline name.

--workspace-name

The workspace name.

Optional Parameters

--no-wait

Do not wait for the long-running operation to finish.

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 show

Edit

Get a pipeline.

az synapse pipeline show --name
                         --workspace-name

Examples

Get a pipeline.

az synapse pipeline show --workspace-name testsynapseworkspace \
  --name testpipeline

Required Parameters

--name -n

The pipeline name.

--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.

az synapse pipeline update

Edit

Update an exist pipeline.

az synapse pipeline update --file
                           --name
                           --workspace-name
                           [--no-wait]

Examples

Update an exist pipeline. Pay attention to add "@" at the front of the file path as the best practice for complex arguments like JSON string.

az synapse pipeline update --workspace-name testsynapseworkspace \
  --name testpipeline --file @"path/pipeline.json"

Required Parameters

--file

Properties may be supplied from a JSON file using the @{path} syntax or a JSON string.

--name -n

The pipeline name.

--workspace-name

The workspace name.

Optional Parameters

--no-wait

Do not wait for the long-running operation to finish.

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.