Share via


DedicatedHostPropertiesOutput 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

Default: 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?: DedicatedHostInstanceViewOutput

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

Default: None

licenseType?: "None" | "Windows_Server_Hybrid" | "Windows_Server_Perpetual"

Property Value

"None" | "Windows_Server_Hybrid" | "Windows_Server_Perpetual"

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?: string

Property Value

string

timeCreated

Specifies the time at which the Dedicated Host resource was created.

Minimum api-version: 2021-11-01.

timeCreated?: string

Property Value

string

virtualMachines

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

virtualMachines?: SubResourceReadOnlyOutput[]

Property Value