az vm host

Manage Dedicated Hosts for Virtual Machines.

Commands

az vm host create Create a dedicated host.
az vm host delete Delete a dedicated host.
az vm host get-instance-view Get instance information about a dedicated host.
az vm host group Manage Dedicated Host Groups.
az vm host group create Create a dedicated host group.
az vm host group delete Delete 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 list List dedicated hosts.
az vm host show Get the details of a dedicated host.
az vm host update Update a dedicated host.

az vm host create

Create a dedicated host.

az vm host create --host-group
--name
--resource-group
--sku {DSv3-Type1, ESv3-Type1, FSv2-Type2}
[--auto-replace {false, true}]
[--license-type {None, Windows_Server_Hybrid, Windows_Server_Perpetual}]
[--location]
[--platform-fault-domain]
[--subscription]
[--tags]

Examples

Create a dedicated host. Ensure it auto replaces on failure

az vm host create --host-group my-host-group --name my-host --platform-fault-domain 2 \
    --auto-replace --resource-group my-resource-group --sku DSv3-Type1

Create a dedicated host in the 'east asia' region. Don't auto replace on failure.

az vm host create --host-group my-host-group --name my-host --platform-fault-domain 0 \
    --auto-replace false --resource-group my-resource-group --sku ESv3-Type1 --location eastasia

Required Parameters

--host-group

Name of the Dedicated Host Group.

--name -n

Name of the Dedicated Host.

--resource-group -g

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

--sku

Sku of the dedicated host.

accepted values: DSv3-Type1, ESv3-Type1, FSv2-Type2

Optional Parameters

--auto-replace

Replace the host automatically if a failure occurs.

accepted values: false, true
--license-type

The software license type that will be applied to the VMs deployed on the dedicated host.

accepted values: None, Windows_Server_Hybrid, Windows_Server_Perpetual
--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 -d

Fault domain of the host within a group. Allowed values: 0, 1, 2.

--subscription

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

--tags

Space-separated tags in 'key[=value]' format. Use "" to clear existing tags.

az vm host delete

Delete a dedicated host.

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

Optional Parameters

--host-group

Name of the Dedicated Host Group.

--ids

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

--name -n

Name of the Dedicated Host.

--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 get-instance-view

Get instance information about a dedicated host.

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

Examples

Get instance view information of a dedicated host.

az vm host get-instance-view --host-group my-host-group --name my-host -g my-rg

Get instance views for all dedicated hosts in a host group.

az vm host get-instance-view --ids $(az vm host list -g my-rg --host-group my-host-group --query "[].id" -o tsv)

Optional Parameters

--host-group

Name of the Dedicated Host Group.

--ids

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

--name -n

Name of the Dedicated Host.

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

List dedicated hosts.

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

Examples

List dedicated hosts. (autogenerated)

az vm host list --host-group my-host-group --resource-group my-rg

Required Parameters

--host-group

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

--subscription

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

az vm host show

Get the details of a dedicated host.

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

Examples

Get the details of a dedicated host (autogenerated)

az vm host show --host-group my-host-group --name MyDedicatedHost --resource-group MyResourceGroup

Optional Parameters

--host-group

Name of the Dedicated Host Group.

--ids

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

--name -n

Name of the Dedicated Host.

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

Update a dedicated host.

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

Examples

Update the 'autoReplaceOnFailure' field of a dedicated host.

az vm host update --host-group my-host-group --name my-host \
    --resource-group my-resource-group --set autoReplaceOnFailure=True

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.

--host-group

Name of the Dedicated Host Group.

--ids

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

--name -n

Name of the Dedicated Host.

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