Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The hostGroups resource type can be deployed with operations that target:
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@2019-03-01' = {
scope: resourceSymbolicName or scope
___location: 'string'
name: 'string'
properties: {
platformFaultDomainCount: int
}
tags: {
{customized property}: 'string'
}
zones: [
'string'
]
}
Property Values
Microsoft.Compute/hostGroups
| Name | Description | Value |
|---|---|---|
| ___location | Resource ___location | string (required) |
| name | The resource name | string (required) |
| properties | Dedicated Host Group Properties. | DedicatedHostGroupProperties |
| scope | Use when creating a resource at a scope that is different than the deployment scope. | Set this property to the symbolic name of a resource to apply the extension resource. |
| 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[] |
DedicatedHostGroupProperties
| Name | Description | Value |
|---|---|---|
| platformFaultDomainCount | Number of fault domains that the host group can span. | int Constraints: Min value = 1 Max value = 3 (required) |
ResourceTags
| Name | Description | Value |
|---|
ARM template resource definition
The hostGroups resource type can be deployed with operations that target:
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": "2019-03-01",
"name": "string",
"___location": "string",
"properties": {
"platformFaultDomainCount": "int"
},
"tags": {
"{customized property}": "string"
},
"zones": [ "string" ]
}
Property Values
Microsoft.Compute/hostGroups
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2019-03-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[] |
DedicatedHostGroupProperties
| Name | Description | Value |
|---|---|---|
| platformFaultDomainCount | Number of fault domains that the host group can span. | int Constraints: Min value = 1 Max value = 3 (required) |
ResourceTags
| Name | Description | Value |
|---|
Usage Examples
Azure Quickstart Templates
The following Azure 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:
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@2019-03-01"
name = "string"
parent_id = "string"
___location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
platformFaultDomainCount = int
}
zones = [
"string"
]
}
}
Property Values
Microsoft.Compute/hostGroups
| Name | Description | Value |
|---|---|---|
| ___location | Resource ___location | string (required) |
| name | The resource name | string (required) |
| parent_id | The ID of the resource to apply this extension resource to. | string (required) |
| properties | Dedicated Host Group Properties. | DedicatedHostGroupProperties |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.Compute/hostGroups@2019-03-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[] |
DedicatedHostGroupProperties
| Name | Description | Value |
|---|---|---|
| platformFaultDomainCount | Number of fault domains that the host group can span. | int Constraints: Min value = 1 Max value = 3 (required) |
ResourceTags
| Name | Description | Value |
|---|
Usage Examples
Azure Verified Modules
The following Azure Verified Modules can be used to deploy this resource type.
| Module | Description |
|---|---|
| Host Groups | AVM Resource Module for Host Groups |