Dedicated Hosts - Update

Service:

Compute

API Version:

2021-04-01

Update an dedicated host .

HTTP

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}/hosts/{hostName}?api-version=2021-04-01

URI Parameters

Name	In	Required	Type	Description
hostGroupName	path	True	string	The name of the dedicated host group.
hostName	path	True	string	The name of the dedicated host .
resourceGroupName	path	True	string	The name of the resource group.
subscriptionId	path	True	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
api-version	query	True	string	Client Api Version.

Request Body

Name	Type	Description
properties.autoReplaceOnFailure	boolean	Specifies whether the dedicated host should be replaced automatically in case of a failure. The value is defaulted to 'true' when not provided.
properties.licenseType	DedicatedHostLicenseTypes	Specifies the software license type that will be applied to the VMs deployed on the dedicated host. Possible values are: None Windows_Server_Hybrid Windows_Server_Perpetual Default: None
properties.platformFaultDomain	integer	Fault domain of the dedicated host within a dedicated host group.
tags	object	Resource tags

Responses

Name	Type	Description
200 OK	DedicatedHost	OK

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Definitions

Name	Description
DedicatedHost	Specifies information about the Dedicated host.
DedicatedHostAllocatableVM	Represents the dedicated host unutilized capacity in terms of a specific VM size.
DedicatedHostAvailableCapacity	Dedicated host unutilized capacity.
DedicatedHostInstanceView	The instance view of a dedicated host.
DedicatedHostLicenseTypes	Specifies the software license type that will be applied to the VMs deployed on the dedicated host. Possible values are: None Windows_Server_Hybrid Windows_Server_Perpetual Default: None
DedicatedHostUpdate	Specifies information about the dedicated host. Only tags, autoReplaceOnFailure and licenseType may be updated.
InstanceViewStatus	Instance view status.
Sku	Describes a virtual machine scale set sku. NOTE: If the new VM SKU is not supported on the hardware the scale set is currently on, you need to deallocate the VMs in the scale set before you modify the SKU name.
StatusLevelTypes	The level code.
SubResourceReadOnly

DedicatedHost

Object

Specifies information about the Dedicated host.

Name	Type	Description
id	string	Resource Id
location	string	Resource location
name	string	Resource name
properties.autoReplaceOnFailure	boolean	Specifies whether the dedicated host should be replaced automatically in case of a failure. The value is defaulted to 'true' when not provided.
properties.hostId	string	A unique id generated and assigned to the dedicated host by the platform. Does not change throughout the lifetime of the host.
properties.instanceView	DedicatedHostInstanceView	The dedicated host instance view.
properties.licenseType	DedicatedHostLicenseTypes	Specifies the software license type that will be applied to the VMs deployed on the dedicated host. Possible values are: None Windows_Server_Hybrid Windows_Server_Perpetual Default: None
properties.platformFaultDomain	integer	Fault domain of the dedicated host within a dedicated host group.
properties.provisioningState	string	The provisioning state, which only appears in the response.
properties.provisioningTime	string	The date when the host was first provisioned.
properties.virtualMachines	SubResourceReadOnly[]	A list of references to all virtual machines in the Dedicated Host.
sku	Sku	SKU of the dedicated host for Hardware Generation and VM family. Only name is required to be set. List Microsoft.Compute SKUs for a list of possible values.
tags	object	Resource tags
type	string	Resource type

DedicatedHostAllocatableVM

Object

Represents the dedicated host unutilized capacity in terms of a specific VM size.

Name	Type	Description
count	number	Maximum number of VMs of size vmSize that can fit in the dedicated host's remaining capacity.
vmSize	string	VM size in terms of which the unutilized capacity is represented.

DedicatedHostAvailableCapacity

Object

Dedicated host unutilized capacity.

Name	Type	Description
allocatableVMs	DedicatedHostAllocatableVM[]	The unutilized capacity of the dedicated host represented in terms of each VM size that is allowed to be deployed to the dedicated host.

DedicatedHostInstanceView

Object

The instance view of a dedicated host.

Name	Type	Description
assetId	string	Specifies the unique id of the dedicated physical machine on which the dedicated host resides.
availableCapacity	DedicatedHostAvailableCapacity	Unutilized capacity of the dedicated host.
statuses	InstanceViewStatus[]	The resource status information.

DedicatedHostLicenseTypes

Enumeration

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

Possible values are:

None

Windows_Server_Hybrid

Windows_Server_Perpetual

Default: None

Value	Description
None
Windows_Server_Hybrid
Windows_Server_Perpetual

DedicatedHostUpdate

Object

Specifies information about the dedicated host. Only tags, autoReplaceOnFailure and licenseType may be updated.

Name	Type	Description
properties.autoReplaceOnFailure	boolean	Specifies whether the dedicated host should be replaced automatically in case of a failure. The value is defaulted to 'true' when not provided.
properties.hostId	string	A unique id generated and assigned to the dedicated host by the platform. Does not change throughout the lifetime of the host.
properties.instanceView	DedicatedHostInstanceView	The dedicated host instance view.
properties.licenseType	DedicatedHostLicenseTypes	Specifies the software license type that will be applied to the VMs deployed on the dedicated host. Possible values are: None Windows_Server_Hybrid Windows_Server_Perpetual Default: None
properties.platformFaultDomain	integer	Fault domain of the dedicated host within a dedicated host group.
properties.provisioningState	string	The provisioning state, which only appears in the response.
properties.provisioningTime	string	The date when the host was first provisioned.
properties.virtualMachines	SubResourceReadOnly[]	A list of references to all virtual machines in the Dedicated Host.
tags	object	Resource tags

InstanceViewStatus

Object

Instance view status.

Name	Type	Description
code	string	The status code.
displayStatus	string	The short localizable label for the status.
level	StatusLevelTypes	The level code.
message	string	The detailed status message, including for alerts and error messages.
time	string	The time of the status.

Sku

Object

Describes a virtual machine scale set sku. NOTE: If the new VM SKU is not supported on the hardware the scale set is currently on, you need to deallocate the VMs in the scale set before you modify the SKU name.

Name	Type	Description
capacity	integer	Specifies the number of virtual machines in the scale set.
name	string	The sku name.
tier	string	Specifies the tier of virtual machines in a scale set. Possible Values: Standard Basic

StatusLevelTypes

Enumeration

The level code.

Value	Description
Error
Info
Warning

SubResourceReadOnly

Object

Name	Type	Description
id	string	Resource Id