Share via


Microsoft.Compute hostGroups 2021-07-01

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@2021-07-01' = {
  scope: resourceSymbolicName or scope
  ___location: 'string'
  name: 'string'
  properties: {
    platformFaultDomainCount: int
    supportAutomaticPlacement: bool
  }
  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 (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

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": "2021-07-01",
  "name": "string",
  "___location": "string",
  "properties": {
    "platformFaultDomainCount": "int",
    "supportAutomaticPlacement": "bool"
  },
  "tags": {
    "{customized property}": "string"
  },
  "zones": [ "string" ]
}

Property Values

Microsoft.Compute/hostGroups

Name Description Value
apiVersion The api version '2021-07-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 (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

ResourceTags

Name Description Value

Usage Examples

Azure Quickstart Templates

The following Azure Quickstart templates deploy this resource type.

Template Description
Azure Dedicated Hosts

Deploy to Azure
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@2021-07-01"
  name = "string"
  parent_id = "string"
  ___location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      platformFaultDomainCount = int
      supportAutomaticPlacement = bool
    }
    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@2021-07-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 (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

ResourceTags

Name Description Value

Usage Examples

Terraform Samples

A basic example of deploying Dedicated Host Group.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "___location" {
  type    = string
  default = "westeurope"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  ___location = var.___location
}

resource "azapi_resource" "hostGroup" {
  type      = "Microsoft.Compute/hostGroups@2021-11-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  ___location  = var.___location
  body = {
    properties = {
      platformFaultDomainCount = 2
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

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