Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

az sql instance-pool

  • Preview

This command group is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage instance pools.

Commands

Name Description Type Status
az sql instance-pool create

Create an instance pool.

 Core Preview
az sql instance-pool delete

Delete an instance pool.

 Core Preview
az sql instance-pool list

List available instance pools.

 Core Preview
az sql instance-pool show

Get the details for an instance pool.

 Core Preview
az sql instance-pool update

Update an instance pool.

 Core Preview
az sql instance-pool wait

Wait for an instance pool to reach a desired state.

 Core Preview

az sql instance-pool create

Preview

Command group 'sql instance-pool' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Create an instance pool.

az sql instance-pool create --capacity
 --edition --tier
 --family
 --location
 --name
 --resource-group
 --subnet
 [--acquire-policy-token]
 [--change-reference]
 [--license-type {BasePrice, LicenseIncluded}]
 [--maint-config-id]
 [--no-wait]
 [--tags]
 [--vnet-name]

Examples

Example to create an instance pool (include --no-wait in the end to get an asynchronous experience)

az sql instance-pool create -g resource_group_name -n instance_pool_name -l location --subnet /subscriptions/{SubID}/resourceGroups/{ResourceGroup}/providers/Microsoft.Network/virtualNetworks/{VNETName}/subnets/{SubnetName} --license-type LicenseIncluded --capacity 8 -e GeneralPurpose -f Gen5 -m SQL_{Region}_{MaintenanceConfigName} --no-wait

Example to create an instance pool with subnet name and vnet-name

az sql instance-pool create --license-type LicenseIncluded -l northcentralus -n myinstancepool -c 8 -e GeneralPurpose -f Gen5 -g billingPools --subnet mysubnetname --vnet-name myvnetname

Required Parameters

--capacity -c

Capacity of the instance pool in vcores.

Property Value
Parameter group: Performance Level (components) Arguments
--edition --tier -e

The edition component of the sku. Allowed value: GeneralPurpose.

Property Value
Parameter group: Performance Level (components) Arguments
--family -f

The compute generation component of the sku. Allowed value: Gen5.

Property Value
Parameter group: Performance Level (components) Arguments
--location -l

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

--name -n

Instance Pool Name.

--resource-group -g

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

--subnet

Name or ID of the subnet that allows access to an Instance Pool. If subnet name is provided, --vnet-name must be provided.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--license-type

The license type to apply for this instance pool.

Property Value
Accepted values: BasePrice, LicenseIncluded
--maint-config-id -m

Assign maintenance configuration to this managed instance.

--no-wait

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

Property Value
Default value: False
--tags

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

--vnet-name

The virtual network name.

az sql instance-pool delete

Preview

Command group 'sql instance-pool' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Delete an instance pool.

az sql instance-pool delete --name
 --resource-group
 [--acquire-policy-token]
 [--change-reference]
 [--no-wait]
 [--yes]

Examples

Delete an instance pool

az sql instance-pool delete -g mygroup -n myinstancepool --yes

Required Parameters

--name -n

Instance Pool Name.

--resource-group -g

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--no-wait

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

Property Value
Default value: False
--yes -y

Do not prompt for confirmation.

Property Value
Default value: False

az sql instance-pool list

Preview

Command group 'sql instance-pool' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List available instance pools.

az sql instance-pool list [--resource-group]

Examples

List all instance pools in the current subscription.

az sql instance-pool list

List all instance pools in a resource group.

az sql instance-pool list -g mygroup

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--resource-group -g

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

az sql instance-pool show

Preview

Command group 'sql instance-pool' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Get the details for an instance pool.

az sql instance-pool show --name
 --resource-group

Examples

Get the details for an instance pool

az sql instance-pool show -g mygroup -n myinstancepool

Required Parameters

--name -n

Instance Pool Name.

--resource-group -g

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

az sql instance-pool update

Preview

Command group 'sql instance-pool' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Update an instance pool.

az sql instance-pool update --name
 --resource-group
 [--acquire-policy-token]
 [--add]
 [--capacity]
 [--change-reference]
 [--edition --tier]
 [--family]
 [--force-string]
 [--license-type {BasePrice, LicenseIncluded}]
 [--maint-config-id]
 [--no-wait]
 [--remove]
 [--set]
 [--tags]

Examples

Update an instance pool with new tags (make sure they are space separated if there are multiple tags)

az sql instance-pool update -n myinstancepool -g mygroup --tags mykey1=myvalue1 mykey2=myvalue2 --license-type LicenseIncluded --capacity 8 -e GeneralPurpose -f Gen5 -m SQL_{Region}_{MaintenanceConfigName}

Clear the tags assigned to an instance pool

az sql instance-pool update -n myinstancepool -g mygroup --tags ""

Required Parameters

--name -n

Instance Pool Name.

--resource-group -g

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--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>.

Property Value
Parameter group: Generic Update Arguments
Default value: []
--capacity -c

Capacity of the instance pool in vcores.

Property Value
Parameter group: Performance Level (components) Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--edition --tier -e

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

Property Value
Parameter group: Performance Level (components) Arguments
--family -f

The compute generation component of the sku. Allowed values include: Gen4, Gen5.

Property Value
Parameter group: Performance Level (components) Arguments
--force-string

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

Property Value
Parameter group: Generic Update Arguments
Default value: False
--license-type

The license type to apply for this instance pool.

Property Value
Accepted values: BasePrice, LicenseIncluded
--maint-config-id -m

Assign maintenance configuration to this managed instance.

--no-wait

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

Property Value
Default value: False
--remove

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

Property Value
Parameter group: Generic Update Arguments
Default value: []
--set

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

Property Value
Parameter group: Generic Update Arguments
Default value: []
--tags

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

az sql instance-pool wait

Preview

Command group 'sql instance-pool' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Wait for an instance pool to reach a desired state.

az sql instance-pool wait --name
 --resource-group
 [--acquire-policy-token]
 [--change-reference]
 [--created]
 [--custom]
 [--deleted]
 [--exists]
 [--interval]
 [--timeout]
 [--updated]

Examples

Wait until an instance pool gets created.

az sql instance-pool wait -n myinstancepool -g mygroup --created

Required Parameters

--name -n

Instance Pool Name.

--resource-group -g

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--created

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

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--custom

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

Property Value
Parameter group: Wait Condition Arguments
--deleted

Wait until deleted.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--exists

Wait until the resource exists.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--interval

Polling interval in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 30
--timeout

Maximum wait in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

Property Value
Parameter group: Wait Condition Arguments
Default value: False

Feedback

Was this page helpful?