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
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
The SQL pool name.
The performance level.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
The workspace name.
Optional Parameters
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".
Do not wait for the long-running operation to finish.
The Storage Account Type.
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az synapse sql pool delete
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
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.
The SQL pool name.
Do not wait for the long-running operation to finish.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
The workspace name.
Do not prompt for confirmation.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az synapse sql pool list
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
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
The workspace name.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az synapse sql pool list-deleted
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
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
The workspace name.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az synapse sql pool pause
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
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.
The SQL pool name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
The workspace name.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az synapse sql pool restore
Create a new SQL pool by restoring from a backup.
az synapse sql pool restore --dest-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
Name of the sql pool that will be created as the restore destination.
Optional Parameters
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".
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.
The SQL pool name.
The performance level.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
The Storage Account Type.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
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".
The workspace name.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az synapse sql pool resume
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
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.
The SQL pool name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
The workspace name.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az synapse sql pool show
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
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.
The SQL pool name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
The workspace name.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az synapse sql pool show-connection-string
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
Type of client connection provider.
Optional Parameters
Type of authentication.
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.
The SQL pool name.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
The workspace name.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az synapse sql pool update
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
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.
The SQL pool name.
The performance level.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
The workspace name.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az synapse sql pool wait
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.
Optional Parameters
Wait until created with 'provisioningState' at 'Succeeded'.
Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Wait until deleted.
Wait until the resource exists.
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.
Polling interval in seconds.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Maximum wait in seconds.
Wait until updated with provisioningState at 'Succeeded'.
The workspace name.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.