az sql mi

Manage SQL managed instances.

Commands

az sql mi create Create a managed instance.
az sql mi delete Delete a managed instance.
az sql mi list List available managed instances.
az sql mi show Get the details for a managed instance.
az sql mi update Update a managed instance.

az sql mi create

Create a managed instance.

az sql mi create --admin-password
--admin-user
--location
--name
--resource-group
--subnet
[--assign-identity]
[--capacity]
[--collation]
[--edition]
[--family]
[--license-type {BasePrice, LicenseIncluded}]
[--no-wait]
[--proxy-override {Default, Proxy, Redirect}]
[--public-data-endpoint-enabled {false, true}]
[--storage]
[--subscription]
[--timezone-id]
[--vnet-name]

Examples

Create a managed instance with specified parameters and with identity

az sql mi create -g mygroup -n myinstance -l mylocation -i -u myusername -p mypassword --license-type LicenseIncluded --subnet /subscriptions/{SubID}/resourceGroups/{ResourceGroup}/providers/Microsoft.Network/virtualNetworks/{VNETName}/subnets/{SubnetName} --capacity 8 --storage 32GB --edition GeneralPurpose --family Gen4

Create a managed instance with minimal set of parameters

az sql mi create -g mygroup -n myinstance -l mylocation -i -u myusername -p mypassword --subnet /subscriptions/{SubID}/resourceGroups/{ResourceGroup}/providers/Microsoft.Network/virtualNetworks/{VNETName}/subnets/{SubnetName}

Required Parameters

--admin-password -p

The administrator login password (required for managed instance creation).

--admin-user -u

Administrator username for the managed instance. Can only be specified when the managed instance is being created (and is required for creation).

--location -l

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

--name -n

The managed instance 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 Azure Sql Managed Instance. If subnet name is provided, --vnet-name must be provided.

Optional Parameters

--assign-identity -i

Generate and assign an Azure Active Directory Identity for this managed instance for use with key management services like Azure KeyVault.

--capacity -c

The capacity of the managed instance in vcores.

--collation

The collation of the managed instance.

--edition --tier -e

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

--family -f

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

--license-type

The license type to apply for this managed instance.

accepted values: BasePrice, LicenseIncluded
--no-wait

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

--proxy-override

The connection type used for connecting to the instance.

accepted values: Default, Proxy, Redirect
--public-data-endpoint-enabled

Whether or not the public data endpoint is enabled for the instance.

accepted values: false, true
--storage

The storage size of the managed instance. Storage size must be specified in increments of 32 GB.

--subscription

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

--timezone-id

The time zone id for the instance to set. A list of time zone ids is exposed through the sys.time_zone_info (Transact-SQL) view.

--vnet-name

The virtual network name.

az sql mi delete

Delete a managed instance.

az sql mi delete [--ids]
[--name]
[--no-wait]
[--resource-group]
[--subscription]
[--yes]

Examples

Delete a managed instance

az sql mi delete -g mygroup -n myinstance --yes

Optional Parameters

--ids

One or more resource IDs (space-delimited). If provided, no other 'Resource Id' arguments should be specified.

--name -n

The managed instance name.

--no-wait

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

--resource-group -g

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

--subscription

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

--yes -y

Do not prompt for confirmation.

az sql mi list

List available managed instances.

az sql mi list [--resource-group]
[--subscription]

Examples

List all managed instances in the current subscription.

az sql mi list

List all managed instances in a resource group.

az sql mi list -g mygroup

Optional Parameters

--resource-group -g

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

--subscription

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

az sql mi show

Get the details for a managed instance.

az sql mi show [--ids]
[--name]
[--resource-group]
[--subscription]

Examples

Get the details for a managed instance

az sql mi show -g mygroup -n myinstance

Optional Parameters

--ids

One or more resource IDs (space-delimited). If provided, no other 'Resource Id' arguments should be specified.

--name -n

The managed instance name.

--resource-group -g

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

--subscription

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

az sql mi update

Update a managed instance.

az sql mi update [--add]
[--admin-password]
[--assign-identity]
[--capacity]
[--force-string]
[--ids]
[--license-type {BasePrice, LicenseIncluded}]
[--name]
[--no-wait]
[--proxy-override {Default, Proxy, Redirect}]
[--public-data-endpoint-enabled {false, true}]
[--remove]
[--resource-group]
[--set]
[--storage]
[--subscription]

Examples

Updates a mi with specified parameters and with identity

az sql mi update -g mygroup -n myinstance -i -p mypassword --license-type mylicensetype --capacity vcorecapacity --storage storagesize

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

--admin-password -p

The administrator login password (required for managed instance creation).

--assign-identity -i

Generate and assign an Azure Active Directory Identity for this managed instance for use with key management services like Azure KeyVault. If identity is already assigned - do nothing.

--capacity -c

The capacity of the managed instance in vcores.

--force-string

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

--ids

One or more resource IDs (space-delimited). If provided, no other 'Resource Id' arguments should be specified.

--license-type

The license type to apply for this managed instance.

accepted values: BasePrice, LicenseIncluded
--name -n

The managed instance name.

--no-wait

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

--proxy-override

The connection type used for connecting to the instance.

accepted values: Default, Proxy, Redirect
--public-data-endpoint-enabled

Whether or not the public data endpoint is enabled for the instance.

accepted values: false, true
--remove

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

--resource-group -g

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

--set

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

--storage

The storage size of the managed instance. Storage size must be specified in increments of 32 GB.

--subscription

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