Share via

DedicatedHost interface

  • Reference
Package:
@azure/arm-compute-profile-2020-09-01-hybrid

Specifies information about the Dedicated host.

Extends
Resource

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. NOTE: This property will not be serialized. It can only be populated by the server.
instanceView

The dedicated host instance view. NOTE: This property will not be serialized. It can only be populated by the server.
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. NOTE: This property will not be serialized. It can only be populated by the server.
provisioningTime

The date when the host was first provisioned. NOTE: This property will not be serialized. It can only be populated by the server.
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.
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.

Inherited Properties

id

Resource Id NOTE: This property will not be serialized. It can only be populated by the server.
location

Resource location
name

Resource name NOTE: This property will not be serialized. It can only be populated by the server.
tags

Resource tags
type

Resource type NOTE: This property will not be serialized. It can only be populated by the server.

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

DedicatedHostInstanceView

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

Property Value

DedicatedHostLicenseTypes

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

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.

sku: Sku

Property Value

Sku

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

SubResourceReadOnly[]

Inherited Property Details

id

Resource Id NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From Resource.id

location

Resource location

location: string

Property Value

string

Inherited From Resource.location

name

Resource name NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From Resource.name

tags

Resource tags

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

Inherited From Resource.tags

type

Resource type NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From Resource.type