az sql elastic-pool
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
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
The name of the elastic pool.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name of the Azure SQL Server. You can configure the default using az configure --defaults sql-server=<name>
.
Optional Parameters
The capacity component of the sku in integer number of DTUs or vcores.
The maximum capacity (in DTUs or vcores) any one database can consume.
The minumum capacity (in DTUs or vcores) each database is guaranteed.
The edition component of the sku. Allowed values include: Basic, Standard, Premium, GeneralPurpose, BusinessCritical.
The compute generation component of the sku (for vcore skus only). Allowed values include: Gen4, Gen5.
The number of high availability replicas to provision for the database. Only settable for Hyperscale edition.
The license type to apply for this elastic pool.
Specified maintenance configuration id or name for this resource.
The max storage size. If no unit is specified, defaults to bytes (B).
Do not wait for the long-running operation to finish.
The preferred enclave type for the Azure SQL Elastic Pool. Allowed values include: Default, VBS.
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
Specifies whether to enable zone redundancy. Default is true if no value is specified.
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 sql elastic-pool delete
Deletes an elastic pool.
az sql elastic-pool delete [--ids]
[--name]
[--no-wait]
[--resource-group]
[--server]
[--subscription]
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 name of the elastic pool.
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 of the Azure SQL Server. You can configure the default using az configure --defaults sql-server=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
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 sql elastic-pool list
Gets all elastic pools in a server.
az sql elastic-pool list [--ids]
[--resource-group]
[--server]
[--skip]
[--subscription]
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.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name of the Azure SQL Server. You can configure the default using az configure --defaults sql-server=<name>
.
The number of elements in the collection to skip. Default value is None.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
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 sql elastic-pool list-dbs
Gets a list of databases in an elastic pool.
az sql elastic-pool list-dbs [--ids]
[--name]
[--resource-group]
[--server]
[--subscription]
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 name of the elastic pool.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name of the Azure SQL Server. You can configure the default using az configure --defaults sql-server=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
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 sql elastic-pool list-editions
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. Values from: az account list-locations
. You can configure the default location using az configure --defaults location=<location>
.
Optional Parameters
If specified, show only results that are available in the specified region.
Number of DTUs to search for. If unspecified, all DTU sizes are shown.
Edition to search for. If unspecified, all editions are shown.
List of additional details to include in output.
Number of vcores to search for. If unspecified, all vcore sizes are shown.
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 sql elastic-pool show
Gets an elastic pool.
az sql elastic-pool show [--ids]
[--name]
[--resource-group]
[--server]
[--subscription]
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 name of the elastic pool.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name of the Azure SQL Server. You can configure the default using az configure --defaults sql-server=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
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 sql elastic-pool update
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 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>
.
The capacity component of the sku in integer number of DTUs or vcores.
The maximum capacity (in DTUs or vcores) any one database can consume.
The minumum capacity (in DTUs or vcores) each database is guaranteed.
The edition component of the sku. Allowed values include: Basic, Standard, Premium, GeneralPurpose, BusinessCritical.
The compute generation component of the sku (for vcore skus only). Allowed values include: Gen4, Gen5.
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
The number of high availability replicas to provision for the database. Only settable for Hyperscale edition.
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.
Specified maintenance configuration id or name for this resource.
The max storage size. If no unit is specified, defaults to bytes (B).
The name of the elastic pool.
Do not wait for the long-running operation to finish.
Type of enclave to be configured for the elastic pool.
Remove a property or an element from a list. Example: --remove property.list <indexToRemove>
OR --remove propertyToRemove
.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name of the Azure SQL Server. You can configure the default using az configure --defaults sql-server=<name>
.
Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Specifies whether to enable zone redundancy. Default is true if no value is specified.
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.
Azure CLI