Package version:

Interface DedicatedHostGroup

Specifies information about the dedicated host group that the dedicated hosts should be assigned to. Currently, a dedicated host can only be added to a dedicated host group at creation time. An existing dedicated host cannot be added to another dedicated host group.

interface DedicatedHostGroup {
    additionalCapabilities?: DedicatedHostGroupPropertiesAdditionalCapabilities;
    hosts?: SubResourceReadOnly[];
    id?: string;
    instanceView?: DedicatedHostGroupInstanceView;
    location: string;
    name?: string;
    platformFaultDomainCount?: number;
    supportAutomaticPlacement?: boolean;
    tags?: {
        [propertyName: string]: string;
    };
    type?: string;
    zones?: string[];
}

Hierarchy (view full)

Properties

additionalCapabilities? hosts? id? instanceView? location name? platformFaultDomainCount? supportAutomaticPlacement? tags? type? zones?

Properties

OptionaladditionalCapabilities

additionalCapabilities?: DedicatedHostGroupPropertiesAdditionalCapabilities

Enables or disables a capability on the dedicated host group. Minimum api-version: 2022-03-01.

Optional Readonlyhosts

hosts?: SubResourceReadOnly[]

A list of references to all dedicated hosts in the dedicated host group. 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?: DedicatedHostGroupInstanceView

The dedicated host group instance view, which has the list of instance view of the dedicated hosts under the dedicated host group. NOTE: This property will not be serialized. It can only be populated by the server.

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.

OptionalplatformFaultDomainCount

platformFaultDomainCount?: number

Number of fault domains that the host group can span.

OptionalsupportAutomaticPlacement

supportAutomaticPlacement?: boolean

Specifies whether virtual machines or virtual machine scale sets can be placed automatically on the dedicated host group. Automatic placement means resources are allocated on dedicated hosts, that are chosen by Azure, under the dedicated host group. The value is defaulted to 'false' when not provided. Minimum api-version: 2020-06-01.

Optionaltags

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

Resource tags

Optional Readonlytype

type?: string

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

Optionalzones

zones?: string[]

Availability Zone to use for this host group. Only single zone is supported. The zone can be assigned only during creation. If not provided, the group supports all zones in the region. If provided, enforces each host in the group to be in the same zone.

Settings

Member Visibility