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

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

--no-wait

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

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--tags

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

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

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

--name -n

The SQL pool name.

--no-wait

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

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--workspace-name

The workspace name.

--yes -y

Do not prompt for confirmation.

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

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

--query-examples

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.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

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

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

--name -n

The SQL pool name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--workspace-name

The workspace name.

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

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

--name -n

The SQL pool name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--workspace-name

The workspace name.

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

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

--name -n

The SQL pool name.

--query-examples

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.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--workspace-name

The workspace name.

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

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

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

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--tags

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

--workspace-name

The workspace name.

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

SQL pool name.

Optional Parameters

--created

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

--custom

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

--deleted

Wait until deleted.

--exists

Wait until the resource exists.

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

--interval

Polling interval in seconds.

default value: 30
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--timeout

Maximum wait in seconds.

default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

--workspace-name

The workspace name.