DedicatedHostProperties interface

Properties of the dedicated host.

Properties

autoReplaceOnFailure

Specifies whether the dedicated host should be replaced automatically in case of a failure. The value is defaulted to 'true' when not provided.

hostId

A unique id generated and assigned to the dedicated host by the platform. Does not change throughout the lifetime of the host.

instanceView

The dedicated host instance view.

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.

platformFaultDomain

Fault domain of the dedicated host within a dedicated host group.

provisioningState

The provisioning state, which only appears in the response.

provisioningTime

The date when the host was first provisioned.

timeCreated

Specifies the time at which the Dedicated Host resource was created. Minimum api-version: 2021-11-01.

virtualMachines

A list of references to all virtual machines in the Dedicated Host.

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.

hostId?: string

Property Value

string

instanceView

The dedicated host instance view.

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.

provisioningState?: string

Property Value

string

provisioningTime

The date when the host was first provisioned.

provisioningTime?: Date

Property Value

Date

timeCreated

Specifies the time at which the Dedicated Host resource was created. Minimum api-version: 2021-11-01.

timeCreated?: Date

Property Value

Date

virtualMachines

A list of references to all virtual machines in the Dedicated Host.

virtualMachines?: SubResourceReadOnly[]

Property Value