az vm host group

Manage Dedicated Host Groups.

Commands

az vm host group create

Create a dedicated host group.

az vm host group delete

Delete a dedicated host group.

az vm host group get-instance-view

Get instance view of a dedicated host group.

az vm host group list

List dedicated host groups.

az vm host group show

Get the details of a dedicated host group.

az vm host group update

Update a dedicated host group.

az vm host group create

Create a dedicated host group.

az vm host group create --name
                        --resource-group
                        [--automatic-placement {false, true}]
                        [--location]
                        [--platform-fault-domain-count]
                        [--subscription]
                        [--tags]
                        [--zone {1, 2, 3}]

Examples

Create a dedicated host group. (autogenerated)

az vm host group create --name MyDedicatedHostGroup --platform-fault-domain-count 2 --resource-group MyResourceGroup

Required Parameters

--name -n

Name of the Dedicated Host Group.

--resource-group -g

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

Optional Parameters

--automatic-placement

Specify whether virtual machines or virtual machine scale sets can be placed automatically on the dedicated host group. Automatic placement means resources are allocated on dedicated hosts, that are chosen by Azure, under the dedicated host group. The value is defaulted to true when not provided.

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>. Otherwise, location will default to the resource group's location.

--platform-fault-domain-count -c

Number of fault domains that the host group can span. Allowed values: 1, 2, 3.

--subscription

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

--tags

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

--zone -z

Availability zone into which to provision the resource.

accepted values: 1, 2, 3

az vm host group delete

Delete a dedicated host group.

az vm host group delete [--ids]
                        [--name]
                        [--resource-group]
                        [--subscription]
                        [--yes]

Optional Parameters

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

--name -n

Name of the Dedicated Host Group.

--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 vm host group get-instance-view

Get instance view of a dedicated host group.

az vm host group get-instance-view [--ids]
                                   [--name]
                                   [--resource-group]
                                   [--subscription]

Examples

Get instance view of a dedicated host group

az vm host group get-instance-view --name MyDedicatedHostGroup --resource-group MyResourceGroup

Optional Parameters

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

--name -n

Name of the Dedicated Host Group.

--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 vm host group list

List dedicated host groups.

Lists dedicated host groups by subscription. If resource group is specified, lists dedicated host groups by resource group.

az vm host group list [--query-examples]
                      [--resource-group]
                      [--subscription]

Optional Parameters

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

--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 vm host group show

Get the details of a dedicated host group.

az vm host group show [--ids]
                      [--name]
                      [--query-examples]
                      [--resource-group]
                      [--subscription]

Examples

Get the details of a dedicated host group (autogenerated)

az vm host group show --name MyDedicatedHostGroup --resource-group MyResourceGroup

Optional Parameters

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

--name -n

Name of the Dedicated Host Group.

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

--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 vm host group update

Update a dedicated host group.

az vm host group update [--add]
                        [--force-string]
                        [--ids]
                        [--name]
                        [--remove]
                        [--resource-group]
                        [--set]
                        [--subscription]

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

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

Name of the Dedicated Host Group.

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

--subscription

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