Share via

DedicatedHostGroup interface

Package:
@azure/arm-compute

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
TrackedResource

Properties

additionalCapabilities

Enables or disables a capability on the dedicated host group. Minimum api-version: 2022-03-01.
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.
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.
platformFaultDomainCount

Number of fault domains that the host group can span.
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.
zones

The availability zones.

Inherited Properties

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.
location

The geo-location where the resource lives
name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.
tags

Resource tags.
type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

additionalCapabilities

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

additionalCapabilities?: DedicatedHostGroupPropertiesAdditionalCapabilities

Property Value

DedicatedHostGroupPropertiesAdditionalCapabilities

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

SubResourceReadOnly[]

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

DedicatedHostGroupInstanceView

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

The availability zones.

zones?: string[]

Property Value

string[]

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From TrackedResource.id

location

The geo-location where the resource lives

location: string

Property Value

string

Inherited From TrackedResource.location

name

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

name?: string

Property Value

string

Inherited From TrackedResource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

SystemData

Inherited From TrackedResource.systemData

tags

Resource tags.

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

Property Value

{[propertyName: string]: string}

Inherited From TrackedResource.tags

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From TrackedResource.type