az synapse dataset

Manage Synapse's datasets.

Commands

Name	Description	Type	Status
az synapse dataset create	Create a dataset.	Core	GA
az synapse dataset delete	Delete a dataset.	Core	GA
az synapse dataset list	List datasets.	Core	GA
az synapse dataset set	Update an exist dataset.	Core	Deprecated
az synapse dataset show	Get a dataset.	Core	GA
az synapse dataset update	Update an exist dataset.	Core	GA

az synapse dataset create

Edit

Create a dataset.

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

Examples

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

az synapse dataset create --workspace-name testsynapseworkspace \
  --name testdataset --file @"path/dataset.json"

Required Parameters

--file

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

--name -n

The dataset name.

--workspace-name

The workspace name.

Optional Parameters

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

--no-wait

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

Property	Value
Default value:	False

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.

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

Property	Value
Default value:	False

az synapse dataset delete

Edit

Delete a dataset.

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

Examples

Delete a dataset.

az synapse dataset delete --workspace-name testsynapseworkspace \
  --name testdataset

Required Parameters

--name -n

The dataset name.

--workspace-name

The workspace name.

Optional Parameters

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

--no-wait

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

Property	Value
Default value:	False

--yes -y

Do not prompt for confirmation.

Property	Value
Default value:	False

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.

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

Property	Value
Default value:	False

az synapse dataset list

Edit

List datasets.

az synapse dataset list --workspace-name

Examples

List datasets.

az synapse dataset list --workspace-name testsynapseworkspace

Required Parameters

--workspace-name

The workspace name.

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.

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

Property	Value
Default value:	False

az synapse dataset set

Edit

Deprecated

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

Update an exist dataset.

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

Examples

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

az synapse dataset set --workspace-name testsynapseworkspace \
  --name testdataset --file @"path/dataset.json"

Required Parameters

--file

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

--name -n

The dataset name.

--workspace-name

The workspace name.

Optional Parameters

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

--no-wait

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

Property	Value
Default value:	False

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.

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

Property	Value
Default value:	False

az synapse dataset show

Edit

Get a dataset.

az synapse dataset show --name
                        --workspace-name

Examples

Get a dataset.

az synapse dataset show --workspace-name testsynapseworkspace \
  --name testdataset

Required Parameters

--name -n

The dataset name.

--workspace-name

The workspace name.

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.

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

Property	Value
Default value:	False

az synapse dataset update

Edit

Update an exist dataset.

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

Examples

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

az synapse dataset update --workspace-name testsynapseworkspace \
  --name testdataset --file @"path/dataset.json"

Required Parameters

--file

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

--name -n

The dataset name.

--workspace-name

The workspace name.

Optional Parameters

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

--no-wait

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

Property	Value
Default value:	False

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.

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

Property	Value
Default value:	False