Package version:

Interface DedicatedHost

Specifies information about the Dedicated host.

interface DedicatedHost {
    autoReplaceOnFailure?: boolean;
    hostId?: string;
    id?: string;
    instanceView?: DedicatedHostInstanceView;
    licenseType?: DedicatedHostLicenseTypes;
    location: string;
    name?: string;
    platformFaultDomain?: number;
    provisioningState?: string;
    provisioningTime?: any;
    sku: Sku;
    tags?: {
        [propertyName: string]: string;
    };
    timeCreated?: any;
    type?: string;
    virtualMachines?: SubResourceReadOnly[];
}

Hierarchy (view full)

Properties

autoReplaceOnFailure? hostId? id? instanceView? licenseType? location name? platformFaultDomain? provisioningState? provisioningTime? sku tags? timeCreated? type? virtualMachines?

Properties

OptionalautoReplaceOnFailure

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.

Optional ReadonlyhostId

hostId?: string

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.

Optional Readonlyid

id?: string

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

Optional ReadonlyinstanceView

instanceView?: DedicatedHostInstanceView

The dedicated host instance view. NOTE: This property will not be serialized. It can only be populated by the server.

OptionallicenseType

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. The default value is: None.

location

location: string

Resource location

Optional Readonlyname

name?: string

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

OptionalplatformFaultDomain

platformFaultDomain?: number

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

Optional ReadonlyprovisioningState

provisioningState?: string

The provisioning state, which only appears in the response. NOTE: This property will not be serialized. It can only be populated by the server.

Optional ReadonlyprovisioningTime

provisioningTime?: any

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: 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.

Optionaltags

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

Resource tags

Optional ReadonlytimeCreated

timeCreated?: any

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.

Optional Readonlytype

type?: string

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

Optional ReadonlyvirtualMachines

virtualMachines?: SubResourceReadOnly[]

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.

Settings

Member Visibility