az sql elastic-pool

  • Reference

Manage elastic pools.

Commands

Name Description Type Status
az sql elastic-pool create

Create an elastic pool.

 Core GA
az sql elastic-pool delete

Deletes an elastic pool.

 Core GA
az sql elastic-pool list

Gets all elastic pools in a server.

 Core GA
az sql elastic-pool list-dbs

Gets a list of databases in an elastic pool.

 Core GA
az sql elastic-pool list-editions

List elastic pool editions available for the active subscription.

 Core GA
az sql elastic-pool op

Manage operations on an elastic pool.

 Core GA
az sql elastic-pool op cancel

Cancels the asynchronous operation on the elastic pool.

 Core GA
az sql elastic-pool op list

Gets a list of operations performed on the elastic pool.

 Core GA
az sql elastic-pool show

Gets an elastic pool.

 Core GA
az sql elastic-pool update

Update an elastic pool.

 Core GA

az sql elastic-pool create

Edit

Create an elastic pool.

az sql elastic-pool create --name
                           --resource-group
                           --server
                           [--capacity]
                           [--db-dtu-max]
                           [--db-dtu-min]
                           [--edition]
                           [--family]
                           [--ha-replicas]
                           [--license-type {BasePrice, LicenseIncluded}]
                           [--maint-config-id]
                           [--max-size]
                           [--no-wait]
                           [--preferred-enclave-type {Default, VBS}]
                           [--tags]
                           [--zone-redundant {false, true}]

Examples

Create elastic pool with zone redundancy enabled

az sql elastic-pool create -g mygroup -s myserver -n mypool -z

Create elastic pool with zone redundancy explicitly disabled

az sql elastic-pool create -g mygroup -s myserver -n mypool -z false

Create a Standard 100 DTU elastic pool.

az sql elastic-pool create -g mygroup -s myserver -n mydb -e Standard -c 100

Create an elastic pool with GeneralPurpose edition, Gen4 hardware and 1 vcore.

az sql elastic-pool create -g mygroup -s myserver -n mydb -e GeneralPurpose -f Gen4 -c 1

Create an elastic pool with Hyperscale edition, Gen5 hardware, 4 vcore and 2 high availability replicas.

az sql elastic-pool create -g mygroup -s myserver -n mydb -e Hyperscale -f Gen5 -c 4 --ha-replicas 2

Create an elastic pool with VBS enclave.

az sql elastic-pool create -g mygroup -s myserver -n mydb --preferred-enclave-type VBS

Required Parameters

--name -n

The name of the elastic pool.

--resource-group -g

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

--server -s

Name of the Azure SQL Server. You can configure the default using az configure --defaults sql-server=<name>.

Optional Parameters

--capacity --dtu -c

The capacity component of the sku in integer number of DTUs or vcores.

--db-dtu-max --db-max-capacity --db-max-dtu

The maximum capacity (in DTUs or vcores) any one database can consume.

--db-dtu-min --db-min-capacity --db-min-dtu

The minumum capacity (in DTUs or vcores) each database is guaranteed.

--edition --tier -e

The edition component of the sku. Allowed values include: Basic, Standard, Premium, GeneralPurpose, BusinessCritical.

--family -f

The compute generation component of the sku (for vcore skus only). Allowed values include: Gen4, Gen5.

--ha-replicas --read-replicas

The number of high availability replicas to provision for the database. Only settable for Hyperscale edition.

--license-type

The license type to apply for this elastic pool.

accepted values: BasePrice, LicenseIncluded
--maint-config-id -m

Specified maintenance configuration id or name for this resource.

--max-size --storage

The max storage size. If no unit is specified, defaults to bytes (B).

--no-wait

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

default value: False
--preferred-enclave-type

The preferred enclave type for the Azure SQL Elastic Pool. Allowed values include: Default, VBS.

accepted values: Default, VBS
--tags

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

--zone-redundant -z

Specifies whether to enable zone redundancy. Default is true if no value is specified.

accepted values: false, true
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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.

az sql elastic-pool delete

Edit

Deletes an elastic pool.

az sql elastic-pool delete [--ids]
                           [--name]
                           [--no-wait]
                           [--resource-group]
                           [--server]
                           [--subscription]

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 name of the elastic pool.

--no-wait

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

default value: False
--resource-group -g

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

--server -s

Name of the Azure SQL Server. You can configure the default using az configure --defaults sql-server=<name>.

--subscription

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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.

az sql elastic-pool list

Edit

Gets all elastic pools in a server.

az sql elastic-pool list [--ids]
                         [--resource-group]
                         [--server]
                         [--skip]
                         [--subscription]

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.

--resource-group -g

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

--server -s

Name of the Azure SQL Server. You can configure the default using az configure --defaults sql-server=<name>.

--skip

The number of elements in the collection to skip. Default value is None.

--subscription

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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.

az sql elastic-pool list-dbs

Edit

Gets a list of databases in an elastic pool.

az sql elastic-pool list-dbs [--ids]
                             [--name]
                             [--resource-group]
                             [--server]
                             [--subscription]

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 name of the elastic pool.

--resource-group -g

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

--server -s

Name of the Azure SQL Server. You can configure the default using az configure --defaults sql-server=<name>.

--subscription

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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.

az sql elastic-pool list-editions

Edit

List elastic pool editions available for the active subscription.

Also includes available pool DTU settings, storage limits, and per database settings. In order to reduce verbosity, additional storage limits and per database settings are hidden by default.

az sql elastic-pool list-editions --location
                                  [--available]
                                  [--dtu]
                                  [--edition]
                                  [--show-details {db-max-dtu, db-max-size, db-min-dtu, max-size}]
                                  [--vcores]

Examples

Show all elastic pool editions and pool DTU limits in the West US region.

az sql elastic-pool list-editions -l westus -o table

Show all pool DTU limits for Standard edition in the West US region.

az sql elastic-pool list-editions -l westus --edition Standard -o table

Show available max sizes for elastic pools with at least 100 DTUs in the West US region.

az sql elastic-pool list-editions -l westus --dtu 100 --show-details max-size -o table

Show available per database settings for Standard 100 DTU elastic pools in the West US region.

az sql elastic-pool list-editions -l westus --edition Standard --dtu 100 -o table --show-details db-min-dtu db-max-dtu db-max-size

Required Parameters

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

Optional Parameters

--available -a

If specified, show only results that are available in the specified region.

default value: False
--dtu

Number of DTUs to search for. If unspecified, all DTU sizes are shown.

--edition --tier -e

Edition to search for. If unspecified, all editions are shown.

--show-details -d

List of additional details to include in output.

accepted values: db-max-dtu, db-max-size, db-min-dtu, max-size
--vcores

Number of vcores to search for. If unspecified, all vcore sizes are shown.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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.

az sql elastic-pool show

Edit

Gets an elastic pool.

az sql elastic-pool show [--ids]
                         [--name]
                         [--resource-group]
                         [--server]
                         [--subscription]

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 name of the elastic pool.

--resource-group -g

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

--server -s

Name of the Azure SQL Server. You can configure the default using az configure --defaults sql-server=<name>.

--subscription

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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.

az sql elastic-pool update

Edit

Update an elastic pool.

az sql elastic-pool update [--add]
                           [--capacity]
                           [--db-dtu-max]
                           [--db-dtu-min]
                           [--edition]
                           [--family]
                           [--force-string]
                           [--ha-replicas]
                           [--ids]
                           [--maint-config-id]
                           [--max-size]
                           [--name]
                           [--no-wait]
                           [--preferred-enclave-type {Default, VBS}]
                           [--remove]
                           [--resource-group]
                           [--server]
                           [--set]
                           [--subscription]
                           [--zone-redundant {false, true}]

Examples

Update elastic pool with zone redundancy enabled

az sql elastic-pool update -g mygroup -s myserver -n mypool -z

Update elastic pool with zone redundancy explicitly disabled

az sql elastic-pool update -g mygroup -s myserver -n mypool -z false

Update elastic pool with 2 high availability replicas

az sql elastic-pool update -g mygroup -s myserver -n mypool --ha-replicas 2

Update elastic pool with VBS enclave

az sql elastic-pool update -g mygroup -s myserver -n mypool --preferred-enclave-type VBS

Optional Parameters

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

default value: []
--capacity --dtu -c

The capacity component of the sku in integer number of DTUs or vcores.

--db-dtu-max --db-max-capacity --db-max-dtu

The maximum capacity (in DTUs or vcores) any one database can consume.

--db-dtu-min --db-min-capacity --db-min-dtu

The minumum capacity (in DTUs or vcores) each database is guaranteed.

--edition --tier -e

The edition component of the sku. Allowed values include: Basic, Standard, Premium, GeneralPurpose, BusinessCritical.

--family -f

The compute generation component of the sku (for vcore skus only). Allowed values include: Gen4, Gen5.

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

default value: False
--ha-replicas --read-replicas

The number of high availability replicas to provision for the database. Only settable for Hyperscale edition.

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

--maint-config-id -m

Specified maintenance configuration id or name for this resource.

--max-size --storage

The max storage size. If no unit is specified, defaults to bytes (B).

--name -n

The name of the elastic pool.

--no-wait

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

default value: False
--preferred-enclave-type

Type of enclave to be configured for the elastic pool.

accepted values: Default, VBS
--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

default value: []
--resource-group -g

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

--server -s

Name of the Azure SQL Server. You can configure the default using az configure --defaults sql-server=<name>.

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

default value: []
--subscription

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

--zone-redundant -z

Specifies whether to enable zone redundancy. Default is true if no value is specified.

accepted values: false, true
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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.