az synapse sql pool

Manage SQL pools.

Commands

Name	Description	Type	Status
az synapse sql pool audit-policy	Manage a SQL pool's auditing policy.	Core	GA
az synapse sql pool audit-policy show	Get a SQL pool's auditing policy.	Core	GA
az synapse sql pool audit-policy update	Update a SQL pool's auditing policy.	Core	GA
az synapse sql pool classification	Manage sensitivity classifications.	Core	GA
az synapse sql pool classification create	Create a column's sensitivity classification.	Core	GA
az synapse sql pool classification delete	Delete the sensitivity classification of a given column.	Core	GA
az synapse sql pool classification list	Get the sensitivity classifications of a given SQL pool.	Core	GA
az synapse sql pool classification recommendation	Manage sensitivity classification recommendations.	Core	GA
az synapse sql pool classification recommendation disable	Disable sensitivity recommendations for a given column(recommendations are enabled by default on all columns).	Core	GA
az synapse sql pool classification recommendation enable	Enable sensitivity recommendations for a given column(recommendations are enabled by default on all columns).	Core	GA
az synapse sql pool classification recommendation list	List the recommended sensitivity classifications of a given SQL pool.	Core	GA
az synapse sql pool classification show	Get the sensitivity classification of a given column.	Core	GA
az synapse sql pool classification update	Update a column's sensitivity classification.	Core	GA
az synapse sql pool create	Create a SQL pool.	Core	GA
az synapse sql pool delete	Delete a SQL pool.	Core	GA
az synapse sql pool list	List all SQL pools.	Core	GA
az synapse sql pool list-deleted	List all deleted SQL pools.	Core	GA
az synapse sql pool pause	Pause a SQL pool.	Core	GA
az synapse sql pool restore	Create a new SQL pool by restoring from a backup.	Core	GA
az synapse sql pool resume	Resume a SQL pool.	Core	GA
az synapse sql pool show	Get a SQL pool.	Core	GA
az synapse sql pool show-connection-string	Generate a connection string to a SQL pool.	Core	GA
az synapse sql pool tde	Manage a SQL pool's transparent data encryption.	Core	GA
az synapse sql pool tde set	Set a SQL pool's transparent data encryption configuration.	Core	GA
az synapse sql pool tde show	Get a SQL pool's transparent data encryption configuration.	Core	GA
az synapse sql pool threat-policy	Manage a SQL pool's threat detection policies.	Core	GA
az synapse sql pool threat-policy show	Get a SQL pool's threat detection policy.	Core	GA
az synapse sql pool threat-policy update	Update a SQL pool's threat detection policy.	Core	GA
az synapse sql pool update	Update a SQL pool.	Core	GA
az synapse sql pool wait	Place the CLI in a waiting state until a condition of a SQL pool is met.	Core	GA

az synapse sql pool create

Edit

Create a SQL pool.

az synapse sql pool create --name
                           --performance-level
                           --resource-group
                           --workspace-name
                           [--collation]
                           [--no-wait]
                           [--storage-type {GRS, LRS}]
                           [--tags]

Examples

Create a SQL pool.

az synapse sql pool create --name sqlpool --performance-level "DW1000c" \
--workspace-name testsynapseworkspace --resource-group rg --collation "SQL_Latin1_General_CP1_CS_AS"

Required Parameters

--name -n

The SQL pool name.

--performance-level

The performance level.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<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.

--collation

Collation defines the rules that sort and compare data, and cannot be changed after SQL pool creation. The default collation is "SQL_Latin1_General_CP1_CI_AS".

--no-wait

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

Property	Value
Default value:	False

--storage-type

The Storage Account Type.

Property	Value
Parameter group:	Storage Arguments
Accepted values:	GRS, LRS

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

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 sql pool delete

Edit

Delete a SQL pool.

az synapse sql pool delete [--ids]
                           [--name]
                           [--no-wait]
                           [--resource-group]
                           [--subscription]
                           [--workspace-name]
                           [--yes]

Examples

Delete a SQL pool.

az synapse sql pool delete --name sqlpool --workspace-name testsynapseworkspace --resource-group rg

Optional Parameters

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

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

--name -n

The SQL pool name.

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

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

Property	Value
Default value:	False

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

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

--workspace-name

The workspace name.

Property	Value
Parameter group:	Resource Id Arguments

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

--verbose

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

Property	Value
Default value:	False

az synapse sql pool list

Edit

List all SQL pools.

az synapse sql pool list --resource-group
                         --workspace-name

Examples

List SQL pools.

az synapse sql pool list --workspace-name testsynapseworkspace --resource-group rg

Required Parameters

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<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 sql pool list-deleted

Edit

List all deleted SQL pools.

az synapse sql pool list-deleted --resource-group
                                 --workspace-name

Examples

List deleted SQL pools.

az synapse sql pool list-deleted --workspace-name testsynapseworkspace --resource-group rg

Required Parameters

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<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 sql pool pause

Edit

Pause a SQL pool.

az synapse sql pool pause [--ids]
                          [--name]
                          [--resource-group]
                          [--subscription]
                          [--workspace-name]

Examples

Pause a SQL pool.

az synapse sql pool pause --name sqlpool --workspace-name testsynapseworkspace --resource-group rg

Optional Parameters

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

--ids

Property	Value
Parameter group:	Resource Id Arguments

--name -n

The SQL pool name.

Property	Value
Parameter group:	Resource Id Arguments

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

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

--workspace-name

The workspace name.

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

az synapse sql pool restore

Edit

Create a new SQL pool by restoring from a backup.

az synapse sql pool restore --dest-name --destination-name
                            [--deleted-time]
                            [--ids]
                            [--name]
                            [--performance-level]
                            [--resource-group]
                            [--storage-type {GRS, LRS}]
                            [--subscription]
                            [--tags]
                            [--time]
                            [--workspace-name]

Examples

Create a new SQL pool by restoring an existing SQL pool's restore point.

az synapse sql pool restore --name sqlpool --workspace-name testsynapseworkspace --resource-group rg \
--dest-name newsqlpool --time 2020-11-25T02:47:37

Required Parameters

--dest-name --destination-name

Name of the sql pool that will be created as the restore destination.

Optional Parameters

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

--deleted-time

If specified, restore from a deleted database instead of from an existing database. Must match the deleted time of a deleted database in the same server. Either --time or --deleted-time (or both) must be specified. Time should be in following format: "YYYY-MM-DDTHH:MM:SS".

Property	Value
Parameter group:	Restore Point Arguments

--ids

Property	Value
Parameter group:	Resource Id Arguments

--name -n

The SQL pool name.

Property	Value
Parameter group:	Resource Id Arguments

--performance-level

The performance level.

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

--storage-type

The Storage Account Type.

Property	Value
Parameter group:	Storage Arguments
Accepted values:	GRS, LRS

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

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

--time -t

The point in time of the source database that will be restored to create the new database. Must be greater than or equal to the source database's earliestRestoreDate value. Either --time or --deleted-time (or both) must be specified. Time should be in following format: "YYYY-MM-DDTHH:MM:SS".

Property	Value
Parameter group:	Restore Point Arguments

--workspace-name

The workspace name.

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

az synapse sql pool resume

Edit

Resume a SQL pool.

az synapse sql pool resume [--ids]
                           [--name]
                           [--resource-group]
                           [--subscription]
                           [--workspace-name]

Examples

Resume a SQL pool.

az synapse sql pool resume --name sqlpool --workspace-name testsynapseworkspace --resource-group rg

Optional Parameters

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

--ids

Property	Value
Parameter group:	Resource Id Arguments

--name -n

The SQL pool name.

Property	Value
Parameter group:	Resource Id Arguments

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

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

--workspace-name

The workspace name.

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

az synapse sql pool show

Edit

Get a SQL pool.

az synapse sql pool show [--ids]
                         [--name]
                         [--resource-group]
                         [--subscription]
                         [--workspace-name]

Examples

Get a SQL pool.

az synapse sql pool show --name sqlpool --workspace-name testsynapseworkspace --resource-group rg

Optional Parameters

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

--ids

Property	Value
Parameter group:	Resource Id Arguments

--name -n

The SQL pool name.

Property	Value
Parameter group:	Resource Id Arguments

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

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

--workspace-name

The workspace name.

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

az synapse sql pool show-connection-string

Edit

Generate a connection string to a SQL pool.

az synapse sql pool show-connection-string --client {ado.net, jdbc, odbc, php, php_pdo}
                                           [--auth-type {ADIntegrated, ADPassword, SqlPassword}]
                                           [--ids]
                                           [--name]
                                           [--subscription]
                                           [--workspace-name]

Examples

Generate connection string for ado.net

az synapse sql pool show-connection-string --name sqlpool --workspace-name testsynapseworkspace -c ado.net

Required Parameters

--client -c

Type of client connection provider.

Property	Value
Accepted values:	ado.net, jdbc, odbc, php, php_pdo

Optional Parameters

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

--auth-type -a

Type of authentication.

Property	Value
Parameter group:	Authentication Arguments
Default value:	SqlPassword
Accepted values:	ADIntegrated, ADPassword, SqlPassword

--ids

Property	Value
Parameter group:	Resource Id Arguments

--name -n

The SQL pool name.

Property	Value
Parameter group:	Resource Id Arguments
Default value:	<sql pool name>

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

--workspace-name

The workspace name.

Property	Value
Parameter group:	Resource Id Arguments
Default value:	<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.

--verbose

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

Property	Value
Default value:	False

az synapse sql pool update

Edit

Update a SQL pool.

az synapse sql pool update [--ids]
                           [--name]
                           [--performance-level]
                           [--resource-group]
                           [--subscription]
                           [--tags]
                           [--workspace-name]

Examples

Update a SQL pool.

az synapse sql pool update --name sqlpool --workspace-name testsynapseworkspace --resource-group rg \
--tags key1=value1

Optional Parameters

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

--ids

Property	Value
Parameter group:	Resource Id Arguments

--name -n

The SQL pool name.

Property	Value
Parameter group:	Resource Id Arguments

--performance-level

The performance level.

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

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

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

--workspace-name

The workspace name.

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

az synapse sql pool wait

Edit

Place the CLI in a waiting state until a condition of a SQL pool is met.

az synapse sql pool wait --sql-pool-name
                         [--created]
                         [--custom]
                         [--deleted]
                         [--exists]
                         [--ids]
                         [--interval]
                         [--resource-group]
                         [--subscription]
                         [--timeout]
                         [--updated]
                         [--workspace-name]

Required Parameters

--sql-pool-name

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

--created

Wait until created with 'provisioningState' at 'Succeeded'.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Property	Value
Parameter group:	Wait Condition Arguments

--deleted

Wait until deleted.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--exists

Wait until the resource exists.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--ids

Property	Value
Parameter group:	Resource Id Arguments

--interval

Polling interval in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	30

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

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

--timeout

Maximum wait in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--workspace-name

The workspace name.

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

Jaa

az synapse sql pool

Commands

az synapse sql pool create

Examples

Required Parameters

Optional Parameters

az synapse sql pool delete

Examples

Optional Parameters

az synapse sql pool list

Examples

Required Parameters

az synapse sql pool list-deleted

Examples

Required Parameters

az synapse sql pool pause

Examples

Optional Parameters

az synapse sql pool restore

Examples

Required Parameters

Optional Parameters

az synapse sql pool resume

Examples

Optional Parameters

az synapse sql pool show

Examples

Optional Parameters

az synapse sql pool show-connection-string

Examples

Required Parameters

Optional Parameters

az synapse sql pool update

Examples

Optional Parameters

az synapse sql pool wait

Required Parameters

Optional Parameters

Palaute