az sql elastic-pool

Manage elastic pools.

Commands

az sql elastic-pool create Create an elastic pool.
az sql elastic-pool delete Deletes the elastic pool.
az sql elastic-pool list Returns a list of elastic pools in a server.
az sql elastic-pool list-dbs Returns a list of databases in an elastic pool.
az sql elastic-pool list-editions List elastic pool editions available for the active subscription.
az sql elastic-pool show Gets an elastic pool.
az sql elastic-pool update Update an elastic pool.

az sql elastic-pool create

Create an elastic pool.

az sql elastic-pool create --name
--resource-group
--server
[--db-dtu-max]
[--db-dtu-min]
[--dtu]
[--edition]
[--max-size]
[--tags]

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.

Optional Parameters

--db-dtu-max --db-max-dtu
The maximum DTU any one database can consume.
--db-dtu-min --db-min-dtu
The minimum DTU all databases are guaranteed.
--dtu
The total shared DTU for the database elastic pool.
--edition
The edition of the elastic pool.
--max-size --storage
The max storage size of the elastic pool. If no unit is specified, defaults to megabytes (MB).
--tags
Resource tags.

az sql elastic-pool delete

Deletes the elastic pool.

az sql elastic-pool delete --name
--resource-group
--server

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.

az sql elastic-pool list

Returns a list of elastic pools in a server.

az sql elastic-pool list --resource-group
--server

Required Parameters

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

az sql elastic-pool list-dbs

Returns a list of databases in an elastic pool.

az sql elastic-pool list-dbs --name
--resource-group
--server

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.

az sql elastic-pool list-editions

List elastic pool editions available for the active subscription.

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

Examples

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

az sql elastic-pool list-editions -l westus

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

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

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

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 --show-details db-min-dtu db-max-dtu db-max-size

Required Parameters

--location -l
Location. You can configure the default location using `az configure --defaults location=<location>`.

Optional Parameters

--dtu
Elastic pool DTU limit to search for. If unspecified, all DTU limits are shown.
--edition
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

az sql elastic-pool show

Gets an elastic pool.

az sql elastic-pool show --name
--resource-group
--server

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.

az sql elastic-pool update

Update an elastic pool.

az sql elastic-pool update --name
--resource-group
--server
[--add]
[--db-dtu-max]
[--db-dtu-min]
[--dtu]
[--max-size]
[--remove]
[--set]

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.

Optional Parameters

--add
Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty .
--db-dtu-max --db-max-dtu
The maximum DTU any one database can consume.
--db-dtu-min --db-min-dtu
The minimum DTU all databases are guaranteed.
--dtu
TThe total shared DTU for the elastic eool.
--max-size --storage
Storage limit for the elastic pool in MB.
--remove
Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.
--set
Update an object by specifying a property path and value to set. Example: --set property1.property2=.