Κοινή χρήση μέσω

az sql instance-pool

  • Preview
  • Reference

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

Edit
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
                            --family
                            --location
                            --name
                            --resource-group
                            --subnet
                            [--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.

--edition --tier -e

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

--family -f

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

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

--license-type

The license type to apply for this instance pool.

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.

Default value: False
--tags

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

--vnet-name

The virtual network name.

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 instance-pool delete

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

--no-wait

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

Default value: False
--yes -y

Do not prompt for confirmation.

Default value: False
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 instance-pool list

Edit
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

--resource-group -g

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

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 instance-pool show

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

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 instance-pool update

Edit
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
                            [--add]
                            [--capacity]
                            [--edition]
                            [--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

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

Capacity of the instance pool in vcores.

--edition --tier -e

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

--family -f

The compute generation component of the sku. 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
--license-type

The license type to apply for this instance pool.

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.

Default value: False
--remove

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

Default value: []
--set

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

Default value: []
--tags

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

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 instance-pool wait

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

--created

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

Default value: False
--custom

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

--deleted

Wait until deleted.

Default value: False
--exists

Wait until the resource exists.

Default value: False
--interval

Polling interval in seconds.

Default value: 30
--timeout

Maximum wait in seconds.

Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

Default value: False
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.