Share via

az vm availability-set

Group resources into availability sets.

To provide redundancy to an application, it is recommended to group two or more virtual machines in an availability set. This configuration ensures that during either a planned or unplanned maintenance event, at least one virtual machine will be available.

Commands

Name Description Type Status
az vm availability-set convert

Convert an Azure Availability Set to contain VMs with managed disks.

 Core GA
az vm availability-set create

Create an Azure Availability Set.

 Core GA
az vm availability-set delete

Delete an availability set.

 Core GA
az vm availability-set list

List all availability sets in a subscription.

 Core GA
az vm availability-set list-sizes

List all available virtual machine sizes that can be used to create a new virtual machine in an existing availability set.

 Core GA
az vm availability-set show

Get information about an availability set.

 Core GA
az vm availability-set update

Update an Azure Availability Set.

 Core GA

az vm availability-set convert

Edit

Convert an Azure Availability Set to contain VMs with managed disks.

az vm availability-set convert [--availability-set-name --name]
                               [--ids]
                               [--resource-group]
                               [--subscription]

Examples

Convert an availabiity set to use managed disks by name.

az vm availability-set convert -g MyResourceGroup -n MyAvSet

Convert an availability set to use managed disks by ID.

az vm availability-set convert --ids $(az vm availability-set list -g MyResourceGroup --query "[].id" -o tsv)

Optional Parameters

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

--availability-set-name --name -n

The name of the availability set.

Property Value
Parameter group: Resource Id Arguments
--ids

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.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az vm availability-set create

Edit

Create an Azure Availability Set.

For more information, see https://learn.microsoft.com/azure/virtual-machines/availability.

az vm availability-set create --name
                              --resource-group
                              [--additional-events --additional-scheduled-events {false, true}]
                              [--enable-reboot --enable-user-reboot-scheduled-events {false, true}]
                              [--enable-redeploy --enable-user-redeploy-scheduled-events {false, true}]
                              [--___location]
                              [--no-wait]
                              [--platform-fault-___domain-count]
                              [--platform-update-___domain-count]
                              [--ppg]
                              [--tags]
                              [--unmanaged]
                              [--validate]

Examples

Create an availability set.

az vm availability-set create -n MyAvSet -g MyResourceGroup --platform-fault-___domain-count 2 --platform-update-___domain-count 2

Required Parameters

--name -n

Name of the availability set.

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

--additional-events --additional-scheduled-events

The configuration parameter used while creating event grid and resource graph scheduled event setting.

Property Value
Accepted values: false, true
--enable-reboot --enable-user-reboot-scheduled-events

The configuration parameter used while publishing scheduled events additional publishing targets.

Property Value
Accepted values: false, true
--enable-redeploy --enable-user-redeploy-scheduled-events

The configuration parameter used while creating user initiated redeploy scheduled event setting creation.

Property Value
Accepted values: false, true
--___location -l

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

--no-wait

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

Property Value
Default value: False
--platform-fault-___domain-count

Fault Domain count.

Property Value
Default value: 2
--platform-update-___domain-count

Update Domain count. If unspecified, the server will pick the most optimal number like 5.

--ppg

The name or ID of the proximity placement group the availability set should be associated with.

--tags

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

--unmanaged

Contained VMs should use unmanaged disks.

Property Value
Default value: False
--validate

Generate and validate the ARM template without creating any resources.

Property Value
Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

az vm availability-set delete

Edit

Delete an availability set.

az vm availability-set delete [--availability-set-name --name]
                              [--ids]
                              [--resource-group]
                              [--subscription]

Examples

Delete an availability set.

az vm availability-set delete -n MyAvSet -g MyResourceGroup

Optional Parameters

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

--availability-set-name --name -n

The name of the availability set.

Property Value
Parameter group: Resource Id Arguments
--ids

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.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az vm availability-set list

Edit

List all availability sets in a subscription.

az vm availability-set list [--expand]
                            [--max-items]
                            [--next-token]
                            [--resource-group]

Optional Parameters

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

--expand

The expand expression to apply to the operation. Allowed values are 'virtualMachines/$ref'.

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

Property Value
Parameter group: Pagination Arguments
--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

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

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

az vm availability-set list-sizes

Edit

List all available virtual machine sizes that can be used to create a new virtual machine in an existing availability set.

az vm availability-set list-sizes [--availability-set-name --name]
                                  [--ids]
                                  [--resource-group]
                                  [--subscription]

Examples

List VM sizes for an availability set.

az vm availability-set list-sizes -n MyAvSet -g MyResourceGroup

Optional Parameters

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

--availability-set-name --name -n

The name of the availability set.

Property Value
Parameter group: Resource Id Arguments
--ids

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.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az vm availability-set show

Edit

Get information about an availability set.

az vm availability-set show [--availability-set-name --name]
                            [--ids]
                            [--resource-group]
                            [--subscription]

Examples

Get information about an availability set.

az vm availability-set show -n MyAvSet -g MyResourceGroup

Optional Parameters

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

--availability-set-name --name -n

The name of the availability set.

Property Value
Parameter group: Resource Id Arguments
--ids

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.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az vm availability-set update

Edit

Update an Azure Availability Set.

az vm availability-set update [--add]
                              [--additional-events --additional-scheduled-events {0, 1, f, false, n, no, t, true, y, yes}]
                              [--availability-set-name --name]
                              [--enable-reboot --enable-user-reboot-scheduled-events {0, 1, f, false, n, no, t, true, y, yes}]
                              [--enable-redeploy --enable-user-redeploy-scheduled-events {0, 1, f, false, n, no, t, true, y, yes}]
                              [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                              [--ids]
                              [--ppg]
                              [--remove]
                              [--resource-group]
                              [--set]
                              [--subscription]

Examples

Update an availability set

az vm availability-set update -n MyAvSet -g MyResourceGroup

Update an availability set tag.

az vm availability-set update -n MyAvSet -g MyResourceGroup --set tags.foo=value

Remove an availability set tag.

az vm availability-set update -n MyAvSet -g MyResourceGroup --remove tags.foo

Optional Parameters

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

--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
--additional-events --additional-scheduled-events

The configuration parameter used while creating event grid and resource graph scheduled event setting.

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--availability-set-name --name -n

The name of the availability set.

Property Value
Parameter group: Resource Id Arguments
--enable-reboot --enable-user-reboot-scheduled-events

The configuration parameter used while publishing scheduled events additional publishing targets.

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--enable-redeploy --enable-user-redeploy-scheduled-events

The configuration parameter used while creating user initiated redeploy scheduled event setting creation.

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--force-string

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

Property Value
Parameter group: Generic Update Arguments
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--ids

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.

Property Value
Parameter group: Resource Id Arguments
--ppg

Name or ID of the proximity placement group that the availability set should be associated with.

--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
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--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
--subscription

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

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False