Microsoft.Compute hostGroups/hosts 2023-03-01

• Latest
• 2024-07-01
• 2024-03-01
• 2023-09-01
• 2023-07-01
• 2023-03-01
• 2022-11-01
• 2022-08-01
• 2022-03-01
• 2021-11-01
• 2021-07-01
• 2021-04-01
• 2021-03-01
• 2020-12-01

Bicep resource definition

The hostGroups/hosts 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/hosts resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Compute/hostGroups/hosts@2023-03-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    capacity: int
    name: 'string'
    tier: 'string'
  }
  parent: resourceSymbolicName
  properties: {
    autoReplaceOnFailure: bool
    licenseType: 'string'
    platformFaultDomain: int
  }
}

Property values

hostGroups/hosts

Name	Description	Value
name	The resource name See how to set names and types for child resources in Bicep.	string (required)
location	Resource location	string (required)
tags	Resource tags	Dictionary of tag names and values. See Tags in templates
sku	SKU of the dedicated host for Hardware Generation and VM family. Only name is required to be set. List Microsoft.Compute SKUs for a list of possible values.	Sku (required)
parent	In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource.	Symbolic name for resource of type: hostGroups
properties	Properties of the dedicated host.	DedicatedHostProperties

DedicatedHostProperties

Name	Description	Value
autoReplaceOnFailure	Specifies whether the dedicated host should be replaced automatically in case of a failure. The value is defaulted to 'true' when not provided.	bool
licenseType	Specifies the software license type that will be applied to the VMs deployed on the dedicated host. Possible values are: None, Windows_Server_Hybrid, Windows_Server_Perpetual. The default value is: None.	'None' 'Windows_Server_Hybrid' 'Windows_Server_Perpetual'
platformFaultDomain	Fault domain of the dedicated host within a dedicated host group.	int Constraints: Min value = 0

Sku

Name	Description	Value
capacity	Specifies the number of virtual machines in the scale set.	int
name	The sku name.	string
tier	Specifies the tier of virtual machines in a scale set. Possible Values: Standard Basic	string

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.

ARM template resource definition

The hostGroups/hosts 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/hosts resource, add the following JSON to your template.

{
  "type": "Microsoft.Compute/hostGroups/hosts",
  "apiVersion": "2023-03-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "capacity": "int",
    "name": "string",
    "tier": "string"
  },
  "properties": {
    "autoReplaceOnFailure": "bool",
    "licenseType": "string",
    "platformFaultDomain": "int"
  }
}

Property values

hostGroups/hosts

Name	Description	Value
type	The resource type	'Microsoft.Compute/hostGroups/hosts'
apiVersion	The resource api version	'2023-03-01'
name	The resource name See how to set names and types for child resources in JSON ARM templates.	string (required)
location	Resource location	string (required)
tags	Resource tags	Dictionary of tag names and values. See Tags in templates
sku	SKU of the dedicated host for Hardware Generation and VM family. Only name is required to be set. List Microsoft.Compute SKUs for a list of possible values.	Sku (required)
properties	Properties of the dedicated host.	DedicatedHostProperties

DedicatedHostProperties

Name	Description	Value
autoReplaceOnFailure	Specifies whether the dedicated host should be replaced automatically in case of a failure. The value is defaulted to 'true' when not provided.	bool
licenseType	Specifies the software license type that will be applied to the VMs deployed on the dedicated host. Possible values are: None, Windows_Server_Hybrid, Windows_Server_Perpetual. The default value is: None.	'None' 'Windows_Server_Hybrid' 'Windows_Server_Perpetual'
platformFaultDomain	Fault domain of the dedicated host within a dedicated host group.	int Constraints: Min value = 0

Sku

Name	Description	Value
capacity	Specifies the number of virtual machines in the scale set.	int
name	The sku name.	string
tier	Specifies the tier of virtual machines in a scale set. Possible Values: Standard Basic	string

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/hosts 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/hosts resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Compute/hostGroups/hosts@2023-03-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      autoReplaceOnFailure = bool
      licenseType = "string"
      platformFaultDomain = int
    }
    sku = {
      capacity = int
      name = "string"
      tier = "string"
    }
  })
}

Property values

hostGroups/hosts

Name	Description	Value
type	The resource type	"Microsoft.Compute/hostGroups/hosts@2023-03-01"
name	The resource name	string (required)
location	Resource location	string (required)
parent_id	The ID of the resource that is the parent for this resource.	ID for resource of type: hostGroups
tags	Resource tags	Dictionary of tag names and values.
sku	SKU of the dedicated host for Hardware Generation and VM family. Only name is required to be set. List Microsoft.Compute SKUs for a list of possible values.	Sku (required)
properties	Properties of the dedicated host.	DedicatedHostProperties

DedicatedHostProperties

Name	Description	Value
autoReplaceOnFailure	Specifies whether the dedicated host should be replaced automatically in case of a failure. The value is defaulted to 'true' when not provided.	bool
licenseType	Specifies the software license type that will be applied to the VMs deployed on the dedicated host. Possible values are: None, Windows_Server_Hybrid, Windows_Server_Perpetual. The default value is: None.	"None" "Windows_Server_Hybrid" "Windows_Server_Perpetual"
platformFaultDomain	Fault domain of the dedicated host within a dedicated host group.	int Constraints: Min value = 0

Sku

Name	Description	Value
capacity	Specifies the number of virtual machines in the scale set.	int
name	The sku name.	string
tier	Specifies the tier of virtual machines in a scale set. Possible Values: Standard Basic	string