Microsoft.Compute hostGroups 2021-04-01
Bicep resource definition
The hostGroups resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Compute/hostGroups resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Compute/hostGroups@2021-04-01' = {
location: 'string'
name: 'string'
properties: {
platformFaultDomainCount: int
supportAutomaticPlacement: bool
}
tags: {
{customized property}: 'string'
}
zones: [
'string'
]
}
Property values
DedicatedHostGroupProperties
| Name | Description | Value |
|---|---|---|
| platformFaultDomainCount | Number of fault domains that the host group can span. | int Constraints: Min value = 1 (required) |
| 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. |
bool |
Microsoft.Compute/hostGroups
| Name | Description | Value |
|---|---|---|
| location | Resource location | string (required) |
| name | The resource name | string (required) |
| properties | Dedicated Host Group Properties. | DedicatedHostGroupProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| 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. | string[] |
ResourceTags
| Name | Description | Value |
|---|
ARM template resource definition
The hostGroups resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Compute/hostGroups resource, add the following JSON to your template.
{
"type": "Microsoft.Compute/hostGroups",
"apiVersion": "2021-04-01",
"name": "string",
"location": "string",
"properties": {
"platformFaultDomainCount": "int",
"supportAutomaticPlacement": "bool"
},
"tags": {
"{customized property}": "string"
},
"zones": [ "string" ]
}
Property values
DedicatedHostGroupProperties
| Name | Description | Value |
|---|---|---|
| platformFaultDomainCount | Number of fault domains that the host group can span. | int Constraints: Min value = 1 (required) |
| 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. |
bool |
Microsoft.Compute/hostGroups
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2021-04-01' |
| location | Resource location | string (required) |
| name | The resource name | string (required) |
| properties | Dedicated Host Group Properties. | DedicatedHostGroupProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.Compute/hostGroups' |
| 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. | string[] |
ResourceTags
| Name | Description | Value |
|---|
Quickstart templates
The following quickstart templates deploy this resource type.
| Template | Description |
|---|---|
Azure Dedicated Hosts |
This will deploy an isolated environment using Azure Dedicated Hosts for you to provision VMs. |
Terraform (AzAPI provider) resource definition
The hostGroups resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Compute/hostGroups resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Compute/hostGroups@2021-04-01"
name = "string"
location = "string"
tags = {
{customized property} = "string"
}
zones = [
"string"
]
body = jsonencode({
properties = {
platformFaultDomainCount = int
supportAutomaticPlacement = bool
}
})
}
Property values
DedicatedHostGroupProperties
| Name | Description | Value |
|---|---|---|
| platformFaultDomainCount | Number of fault domains that the host group can span. | int Constraints: Min value = 1 (required) |
| 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. |
bool |
Microsoft.Compute/hostGroups
| Name | Description | Value |
|---|---|---|
| location | Resource location | string (required) |
| name | The resource name | string (required) |
| properties | Dedicated Host Group Properties. | DedicatedHostGroupProperties |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.Compute/hostGroups@2021-04-01" |
| 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. | string[] |
ResourceTags
| Name | Description | Value |
|---|