DedicatedHostGroup interface
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.
- Extends
Properties
hosts | 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. |
instance |
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. |
platform |
Number of fault domains that the host group can span. |
support |
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. |
zones | 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. |
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
hosts
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.
hosts?: SubResourceReadOnly[]
Property Value
instanceView
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.
instanceView?: DedicatedHostGroupInstanceView
Property Value
platformFaultDomainCount
Number of fault domains that the host group can span.
platformFaultDomainCount?: number
Property Value
number
supportAutomaticPlacement
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.
supportAutomaticPlacement?: boolean
Property Value
boolean
zones
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.
zones?: string[]
Property Value
string[]
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
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