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/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@2020-06-01' = {
parent: resourceSymbolicName
location: 'string'
name: 'string'
properties: {
autoReplaceOnFailure: bool
licenseType: 'string'
platformFaultDomain: int
}
sku: {
capacity: int
name: 'string'
tier: 'string'
}
tags: {
{customized property}: 'string'
}
}
Property Values
Microsoft.Compute/hostGroups/hosts
| Name | Description | Value |
|---|---|---|
| location | Resource location | string (required) |
| name | The resource name | string (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 |
| 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) |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
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 Default: 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 |
ResourceTags
| Name | Description | Value |
|---|
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 |
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": "2020-06-01",
"name": "string",
"location": "string",
"properties": {
"autoReplaceOnFailure": "bool",
"licenseType": "string",
"platformFaultDomain": "int"
},
"sku": {
"capacity": "int",
"name": "string",
"tier": "string"
},
"tags": {
"{customized property}": "string"
}
}
Property Values
Microsoft.Compute/hostGroups/hosts
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2020-06-01' |
| location | Resource location | string (required) |
| name | The resource name | string (required) |
| properties | Properties of the dedicated host. | DedicatedHostProperties |
| 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) |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.Compute/hostGroups/hosts' |
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 Default: 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 |
ResourceTags
| Name | Description | Value |
|---|
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 |
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/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@2020-06-01"
name = "string"
parent_id = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
autoReplaceOnFailure = bool
licenseType = "string"
platformFaultDomain = int
}
sku = {
capacity = int
name = "string"
tier = "string"
}
}
}
Property Values
Microsoft.Compute/hostGroups/hosts
| Name | Description | Value |
|---|---|---|
| location | Resource location | string (required) |
| name | The resource name | string (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: hostGroups |
| properties | Properties of the dedicated host. | DedicatedHostProperties |
| 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) |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.Compute/hostGroups/hosts@2020-06-01" |
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 Default: 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 |
ResourceTags
| Name | Description | Value |
|---|
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 |