az synapse data-flow

Manage Synapse's data flows.

Commands

Name	Description	Type	Status
az synapse data-flow create	Create a data flow.	Core	GA
az synapse data-flow delete	Delete a data flow.	Core	GA
az synapse data-flow list	List data flows.	Core	GA
az synapse data-flow set	Set an exist data flow.	Core	GA
az synapse data-flow show	Get a data flow.	Core	GA

az synapse data-flow create

Create a data flow.

az synapse data-flow create --file
                            --name
                            --workspace-name
                            [--no-wait]

Examples

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

az synapse data-flow create --workspace-name testsynapseworkspace \
  --name testdataflow --file @"path/dataflow.json"

Required Parameters

--file

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

--name -n

The data flow 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 data-flow delete

Delete a data flow.

az synapse data-flow delete --name
                            --workspace-name
                            [--no-wait]
                            [--yes]

Examples

Delete a data flow.

az synapse data-flow delete --workspace-name testsynapseworkspace \
  --name testdataflow

Required Parameters

--name -n

The data flow 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 data-flow list

List data flows.

az synapse data-flow list --workspace-name

Examples

List data flows.

az synapse data-flow 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 data-flow set

Set an exist data flow.

az synapse data-flow set --file
                         --name
                         --workspace-name
                         [--no-wait]

Examples

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

az synapse data-flow set --workspace-name testsynapseworkspace \
  --name testdataflow --file @"path/dataflow.json"

Required Parameters

--file

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

--name -n

The data flow 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 data-flow show

Get a data flow.

az synapse data-flow show --name
                          --workspace-name

Examples

Get a data flow.

az synapse data-flow show --workspace-name testsynapseworkspace \
  --name testdataflow

Required Parameters

--name -n

The data flow 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.