DedicatedHostUpdate interface
Specifies information about the dedicated host. Only tags, autoReplaceOnFailure and licenseType may be updated.
- Extends
Properties
auto |
Specifies whether the dedicated host should be replaced automatically in case of a failure. The value is defaulted to 'true' when not provided. |
host |
A unique id generated and assigned to the dedicated host by the platform. Does not change throughout the lifetime of the host. NOTE: This property will not be serialized. It can only be populated by the server. |
instance |
The dedicated host instance view. NOTE: This property will not be serialized. It can only be populated by the server. |
license |
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. The default value is: None. |
platform |
Fault domain of the dedicated host within a dedicated host group. |
provisioning |
The provisioning state, which only appears in the response. NOTE: This property will not be serialized. It can only be populated by the server. |
provisioning |
The date when the host was first provisioned. NOTE: This property will not be serialized. It can only be populated by the server. |
sku | [List all available dedicated host sizes for resizing] (https://docs.microsoft.com/rest/api/compute/dedicated-hosts/listavailablesizes). Resizing can be only used to scale up DedicatedHost. Only name is required to be set. |
time |
Specifies the time at which the Dedicated Host resource was created. Minimum api-version: 2021-11-01. NOTE: This property will not be serialized. It can only be populated by the server. |
virtual |
A list of references to all virtual machines in the Dedicated Host. NOTE: This property will not be serialized. It can only be populated by the server. |
Inherited Properties
tags | Resource tags |
Property Details
autoReplaceOnFailure
Specifies whether the dedicated host should be replaced automatically in case of a failure. The value is defaulted to 'true' when not provided.
autoReplaceOnFailure?: boolean
Property Value
boolean
hostId
A unique id generated and assigned to the dedicated host by the platform. Does not change throughout the lifetime of the host. NOTE: This property will not be serialized. It can only be populated by the server.
hostId?: string
Property Value
string
instanceView
The dedicated host instance view. NOTE: This property will not be serialized. It can only be populated by the server.
instanceView?: DedicatedHostInstanceView
Property Value
licenseType
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. The default value is: None.
licenseType?: DedicatedHostLicenseTypes
Property Value
platformFaultDomain
Fault domain of the dedicated host within a dedicated host group.
platformFaultDomain?: number
Property Value
number
provisioningState
The provisioning state, which only appears in the response. NOTE: This property will not be serialized. It can only be populated by the server.
provisioningState?: string
Property Value
string
provisioningTime
The date when the host was first provisioned. NOTE: This property will not be serialized. It can only be populated by the server.
provisioningTime?: Date
Property Value
Date
sku
[List all available dedicated host sizes for resizing] (https://docs.microsoft.com/rest/api/compute/dedicated-hosts/listavailablesizes). Resizing can be only used to scale up DedicatedHost. Only name is required to be set.
sku?: Sku
Property Value
timeCreated
Specifies the time at which the Dedicated Host resource was created. Minimum api-version: 2021-11-01. NOTE: This property will not be serialized. It can only be populated by the server.
timeCreated?: Date
Property Value
Date
virtualMachines
A list of references to all virtual machines in the Dedicated Host. NOTE: This property will not be serialized. It can only be populated by the server.
virtualMachines?: SubResourceReadOnly[]
Property Value
Inherited Property Details
tags
Resource tags
tags?: {[propertyName: string]: string}
Property Value
{[propertyName: string]: string}
Inherited From UpdateResource.tags