az synapse sql pool
Manage SQL pools.
Commands
az synapse sql pool create |
Create a SQL pool. |
az synapse sql pool delete |
Delete a SQL pool. |
az synapse sql pool list |
List all SQL pools. |
az synapse sql pool pause |
Pause a SQL pool. |
az synapse sql pool resume |
Resume a SQL pool. |
az synapse sql pool show |
Get a SQL pool. |
az synapse sql pool update |
Update a SQL pool. |
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 create
Create a SQL pool.
az synapse sql pool create --name
--performance-level
--resource-group
--workspace-name
[--no-wait]
[--subscription]
[--tags]
Examples
Create a SQL pool.
az synapse sql pool create --name sqlpoolcli1 --performance-level "DW1000c" \
--workspace-name testsynapseworkspace --resource-group rg
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
Do not wait for the long-running operation to finish.
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.
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.
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 sqlpoolcli1 --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.
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.
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
[--query-examples]
[--subscription]
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.
Optional Parameters
Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
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.
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 sqlpoolcli1 --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.
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.
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 sqlpoolcli1 --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.
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.
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]
[--query-examples]
[--resource-group]
[--subscription]
[--workspace-name]
Examples
Get a SQL pool.
az synapse sql pool show --name sqlpoolcli1 --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.
Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.
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.
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.
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 sqlpoolcli1 --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.
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.
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.
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.
Increase logging verbosity. Use --debug for full debug logs.