Dedicated Host Groups - Create Or Update

Service:

Compute

API Version:

2025-11-01

Create or update a dedicated host group. For details of Dedicated Host and Dedicated Host Groups please see [Dedicated Host Documentation] (https://go.microsoft.com/fwlink/?linkid=2082596)

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}?api-version=2025-11-01

URI Parameters

Name	In	Required	Type	Description
hostGroupName	path	True	string	The name of the dedicated host group.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string minLength: 1	The ID of the target subscription.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Request Body

Name	Required	Type	Description
location	True	string	The geo-location where the resource lives
properties.platformFaultDomainCount	True	integer (int32) minimum: 1	Number of fault domains that the host group can span.
properties.additionalCapabilities		DedicatedHostGroupPropertiesAdditionalCapabilities	Enables or disables a capability on the dedicated host group. Minimum api-version: 2022-03-01.
properties.supportAutomaticPlacement		boolean	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.
tags		object	Resource tags.
zones		string[]	The availability zones.

Responses

Name	Type	Description
200 OK	DedicatedHostGroup	Resource 'DedicatedHostGroup' update operation succeeded
201 Created	DedicatedHostGroup	Resource 'DedicatedHostGroup' create operation succeeded
Other Status Codes	CloudError	An unexpected error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Create or update a dedicated host group with Ultra SSD support.

Create or update a dedicated host group.

Create or update a dedicated host group with Ultra SSD support.

Sample request

HTTP

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/hostGroups/myDedicatedHostGroup?api-version=2025-11-01

{
  "location": "westus",
  "tags": {
    "department": "finance"
  },
  "zones": [
    "1"
  ],
  "properties": {
    "platformFaultDomainCount": 3,
    "supportAutomaticPlacement": true,
    "additionalCapabilities": {
      "ultraSSDEnabled": true
    }
  }
}

Java

import com.azure.resourcemanager.compute.fluent.models.DedicatedHostGroupInner;
import com.azure.resourcemanager.compute.models.DedicatedHostGroupPropertiesAdditionalCapabilities;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for DedicatedHostGroups CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-11-01/dedicatedHostExamples/DedicatedHostGroup_CreateOrUpdate_WithUltraSSD.json
     */
    /**
     * Sample code: Create or update a dedicated host group with Ultra SSD support.
     * 
     * @param manager Entry point to ComputeManager.
     */
    public static void
        createOrUpdateADedicatedHostGroupWithUltraSSDSupport(com.azure.resourcemanager.compute.ComputeManager manager) {
        manager.serviceClient().getDedicatedHostGroups().createOrUpdateWithResponse("myResourceGroup",
            "myDedicatedHostGroup",
            new DedicatedHostGroupInner().withLocation("westus").withTags(mapOf("department", "finance"))
                .withZones(Arrays.asList("1")).withPlatformFaultDomainCount(3).withSupportAutomaticPlacement(true)
                .withAdditionalCapabilities(
                    new DedicatedHostGroupPropertiesAdditionalCapabilities().withUltraSsdEnabled(true)),
            com.azure.core.util.Context.NONE);
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.compute import ComputeManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-compute
# USAGE
    python dedicated_host_group_create_or_update_with_ultra_ssd.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ComputeManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.dedicated_host_groups.create_or_update(
        resource_group_name="myResourceGroup",
        host_group_name="myDedicatedHostGroup",
        parameters={
            "location": "westus",
            "properties": {
                "additionalCapabilities": {"ultraSSDEnabled": True},
                "platformFaultDomainCount": 3,
                "supportAutomaticPlacement": True,
            },
            "tags": {"department": "finance"},
            "zones": ["1"],
        },
    )
    print(response)


# x-ms-original-file: 2025-11-01/dedicatedHostExamples/DedicatedHostGroup_CreateOrUpdate_WithUltraSSD.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armcompute_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/compute/armcompute/v8"
)

// Generated from example definition: 2025-11-01/dedicatedHostExamples/DedicatedHostGroup_CreateOrUpdate_WithUltraSSD.json
func ExampleDedicatedHostGroupsClient_CreateOrUpdate_createOrUpdateADedicatedHostGroupWithUltraSsdSupport() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcompute.NewClientFactory("{subscription-id}", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewDedicatedHostGroupsClient().CreateOrUpdate(ctx, "myResourceGroup", "myDedicatedHostGroup", armcompute.DedicatedHostGroup{
		Location: to.Ptr("westus"),
		Tags: map[string]*string{
			"department": to.Ptr("finance"),
		},
		Zones: []*string{
			to.Ptr("1"),
		},
		Properties: &armcompute.DedicatedHostGroupProperties{
			PlatformFaultDomainCount:  to.Ptr[int32](3),
			SupportAutomaticPlacement: to.Ptr(true),
			AdditionalCapabilities: &armcompute.DedicatedHostGroupPropertiesAdditionalCapabilities{
				UltraSSDEnabled: to.Ptr(true),
			},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armcompute.DedicatedHostGroupsClientCreateOrUpdateResponse{
	// 	DedicatedHostGroup: &armcompute.DedicatedHostGroup{
	// 		Properties: &armcompute.DedicatedHostGroupProperties{
	// 			PlatformFaultDomainCount: to.Ptr[int32](3),
	// 			SupportAutomaticPlacement: to.Ptr(true),
	// 			AdditionalCapabilities: &armcompute.DedicatedHostGroupPropertiesAdditionalCapabilities{
	// 				UltraSSDEnabled: to.Ptr(true),
	// 			},
	// 		},
	// 		Location: to.Ptr("westus"),
	// 		Tags: map[string]*string{
	// 			"department": to.Ptr("finance"),
	// 			"owner": to.Ptr("myCompany"),
	// 		},
	// 		Name: to.Ptr("myDedicatedHostGroup"),
	// 		ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/HostGroups/myDedicatedHostGroup"),
	// 		Zones: []*string{
	// 			to.Ptr("1"),
	// 		},
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { ComputeManagementClient } = require("@azure/arm-compute");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to create or update a dedicated host group. For details of Dedicated Host and Dedicated Host Groups please see [Dedicated Host Documentation] (https://go.microsoft.com/fwlink/?linkid=2082596)
 *
 * @summary create or update a dedicated host group. For details of Dedicated Host and Dedicated Host Groups please see [Dedicated Host Documentation] (https://go.microsoft.com/fwlink/?linkid=2082596)
 * x-ms-original-file: 2025-11-01/dedicatedHostExamples/DedicatedHostGroup_CreateOrUpdate_WithUltraSSD.json
 */
async function createOrUpdateADedicatedHostGroupWithUltraSSDSupport() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "{subscription-id}";
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.dedicatedHostGroups.createOrUpdate(
    "myResourceGroup",
    "myDedicatedHostGroup",
    {
      location: "westus",
      tags: { department: "finance" },
      zones: ["1"],
      platformFaultDomainCount: 3,
      supportAutomaticPlacement: true,
      additionalCapabilities: { ultraSSDEnabled: true },
    },
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Compute;

// Generated from example definition: specification/compute/resource-manager/Microsoft.Compute/Compute/stable/2025-11-01/examples/dedicatedHostExamples/DedicatedHostGroup_CreateOrUpdate_WithUltraSSD.json
// this example is just showing the usage of "DedicatedHostGroups_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "myResourceGroup";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this DedicatedHostGroupResource
DedicatedHostGroupCollection collection = resourceGroupResource.GetDedicatedHostGroups();

// invoke the operation
string hostGroupName = "myDedicatedHostGroup";
DedicatedHostGroupData data = new DedicatedHostGroupData(new AzureLocation("westus"))
{
    Zones = { "1" },
    PlatformFaultDomainCount = 3,
    SupportAutomaticPlacement = true,
    UltraSsdEnabled = true,
    Tags =
    {
    ["department"] = "finance"
    },
};
ArmOperation<DedicatedHostGroupResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, hostGroupName, data);
DedicatedHostGroupResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
DedicatedHostGroupData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:

200

{
  "properties": {
    "platformFaultDomainCount": 3,
    "supportAutomaticPlacement": true,
    "additionalCapabilities": {
      "ultraSSDEnabled": true
    }
  },
  "location": "westus",
  "tags": {
    "department": "finance",
    "owner": "myCompany"
  },
  "name": "myDedicatedHostGroup",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/HostGroups/myDedicatedHostGroup",
  "zones": [
    "1"
  ]
}

Status code:

201

{
  "name": "myDedicatedHostGroup",
  "location": "westus",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/HostGroups/myDedicatedHostGroup",
  "tags": {
    "department": "finance"
  },
  "zones": [
    "1"
  ],
  "properties": {
    "platformFaultDomainCount": 3,
    "supportAutomaticPlacement": true,
    "additionalCapabilities": {
      "ultraSSDEnabled": true
    }
  }
}

Create or update a dedicated host group.

Sample request

HTTP

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/hostGroups/myDedicatedHostGroup?api-version=2025-11-01

{
  "location": "westus",
  "tags": {
    "department": "finance"
  },
  "zones": [
    "1"
  ],
  "properties": {
    "platformFaultDomainCount": 3,
    "supportAutomaticPlacement": true
  }
}

Java

import com.azure.resourcemanager.compute.fluent.models.DedicatedHostGroupInner;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for DedicatedHostGroups CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-11-01/dedicatedHostExamples/DedicatedHostGroup_CreateOrUpdate.json
     */
    /**
     * Sample code: Create or update a dedicated host group.
     * 
     * @param manager Entry point to ComputeManager.
     */
    public static void createOrUpdateADedicatedHostGroup(com.azure.resourcemanager.compute.ComputeManager manager) {
        manager.serviceClient().getDedicatedHostGroups().createOrUpdateWithResponse("myResourceGroup",
            "myDedicatedHostGroup",
            new DedicatedHostGroupInner().withLocation("westus").withTags(mapOf("department", "finance"))
                .withZones(Arrays.asList("1")).withPlatformFaultDomainCount(3).withSupportAutomaticPlacement(true),
            com.azure.core.util.Context.NONE);
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.compute import ComputeManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-compute
# USAGE
    python dedicated_host_group_create_or_update.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ComputeManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.dedicated_host_groups.create_or_update(
        resource_group_name="myResourceGroup",
        host_group_name="myDedicatedHostGroup",
        parameters={
            "location": "westus",
            "properties": {"platformFaultDomainCount": 3, "supportAutomaticPlacement": True},
            "tags": {"department": "finance"},
            "zones": ["1"],
        },
    )
    print(response)


# x-ms-original-file: 2025-11-01/dedicatedHostExamples/DedicatedHostGroup_CreateOrUpdate.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armcompute_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/compute/armcompute/v8"
)

// Generated from example definition: 2025-11-01/dedicatedHostExamples/DedicatedHostGroup_CreateOrUpdate.json
func ExampleDedicatedHostGroupsClient_CreateOrUpdate_createOrUpdateADedicatedHostGroup() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcompute.NewClientFactory("{subscription-id}", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewDedicatedHostGroupsClient().CreateOrUpdate(ctx, "myResourceGroup", "myDedicatedHostGroup", armcompute.DedicatedHostGroup{
		Location: to.Ptr("westus"),
		Tags: map[string]*string{
			"department": to.Ptr("finance"),
		},
		Zones: []*string{
			to.Ptr("1"),
		},
		Properties: &armcompute.DedicatedHostGroupProperties{
			PlatformFaultDomainCount:  to.Ptr[int32](3),
			SupportAutomaticPlacement: to.Ptr(true),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armcompute.DedicatedHostGroupsClientCreateOrUpdateResponse{
	// 	DedicatedHostGroup: &armcompute.DedicatedHostGroup{
	// 		Properties: &armcompute.DedicatedHostGroupProperties{
	// 			PlatformFaultDomainCount: to.Ptr[int32](3),
	// 			SupportAutomaticPlacement: to.Ptr(true),
	// 		},
	// 		Location: to.Ptr("westus"),
	// 		Tags: map[string]*string{
	// 			"department": to.Ptr("finance"),
	// 			"owner": to.Ptr("myCompany"),
	// 		},
	// 		Name: to.Ptr("myDedicatedHostGroup"),
	// 		ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/HostGroups/myDedicatedHostGroup"),
	// 		Zones: []*string{
	// 			to.Ptr("1"),
	// 		},
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { ComputeManagementClient } = require("@azure/arm-compute");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to create or update a dedicated host group. For details of Dedicated Host and Dedicated Host Groups please see [Dedicated Host Documentation] (https://go.microsoft.com/fwlink/?linkid=2082596)
 *
 * @summary create or update a dedicated host group. For details of Dedicated Host and Dedicated Host Groups please see [Dedicated Host Documentation] (https://go.microsoft.com/fwlink/?linkid=2082596)
 * x-ms-original-file: 2025-11-01/dedicatedHostExamples/DedicatedHostGroup_CreateOrUpdate.json
 */
async function createOrUpdateADedicatedHostGroup() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "{subscription-id}";
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.dedicatedHostGroups.createOrUpdate(
    "myResourceGroup",
    "myDedicatedHostGroup",
    {
      location: "westus",
      tags: { department: "finance" },
      zones: ["1"],
      platformFaultDomainCount: 3,
      supportAutomaticPlacement: true,
    },
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Compute;

// Generated from example definition: specification/compute/resource-manager/Microsoft.Compute/Compute/stable/2025-11-01/examples/dedicatedHostExamples/DedicatedHostGroup_CreateOrUpdate.json
// this example is just showing the usage of "DedicatedHostGroups_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "myResourceGroup";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this DedicatedHostGroupResource
DedicatedHostGroupCollection collection = resourceGroupResource.GetDedicatedHostGroups();

// invoke the operation
string hostGroupName = "myDedicatedHostGroup";
DedicatedHostGroupData data = new DedicatedHostGroupData(new AzureLocation("westus"))
{
    Zones = { "1" },
    PlatformFaultDomainCount = 3,
    SupportAutomaticPlacement = true,
    Tags =
    {
    ["department"] = "finance"
    },
};
ArmOperation<DedicatedHostGroupResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, hostGroupName, data);
DedicatedHostGroupResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
DedicatedHostGroupData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:

200

{
  "properties": {
    "platformFaultDomainCount": 3,
    "supportAutomaticPlacement": true
  },
  "location": "westus",
  "tags": {
    "department": "finance",
    "owner": "myCompany"
  },
  "name": "myDedicatedHostGroup",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/HostGroups/myDedicatedHostGroup",
  "zones": [
    "1"
  ]
}

Status code:

201

{
  "name": "myDedicatedHostGroup",
  "location": "westus",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/HostGroups/myDedicatedHostGroup",
  "tags": {
    "department": "finance"
  },
  "zones": [
    "1"
  ],
  "properties": {
    "platformFaultDomainCount": 3,
    "supportAutomaticPlacement": true
  }
}

Definitions

Name	Description
ApiError	Api error.
ApiErrorBase	Api error base.
CloudError	An error response from the Compute service.
createdByType	The type of identity that created the resource.
DedicatedHostAllocatableVM	Represents the dedicated host unutilized capacity in terms of a specific VM size.
DedicatedHostAvailableCapacity	Dedicated host unutilized capacity.
DedicatedHostGroup	Specifies information about the dedicated host group that the dedicated hosts should be assigned to. Currently, a dedicated host can only be added to a dedicated host group at creation time. An existing dedicated host cannot be added to another dedicated host group.
DedicatedHostGroupInstanceView
DedicatedHostGroupPropertiesAdditionalCapabilities	Enables or disables a capability on the dedicated host group. Minimum api-version: 2022-03-01.
DedicatedHostInstanceViewWithName	The instance view of a dedicated host that includes the name of the dedicated host. It is used for the response to the instance view of a dedicated host group.
InnerError	Inner error details.
InstanceViewStatus	Instance view status.
StatusLevelTypes	The level code.
SubResourceReadOnly
systemData	Metadata pertaining to creation and last modification of the resource.

ApiError

Object

Api error.

Name	Type	Description
code	string	The error code.
details	ApiErrorBase[]	The Api error details
innererror	InnerError	The Api inner error
message	string	The error message.
target	string	The target of the particular error.

ApiErrorBase

Object

Api error base.

Name	Type	Description
code	string	The error code.
message	string	The error message.
target	string	The target of the particular error.

CloudError

Object

An error response from the Compute service.

Name	Type	Description
error	ApiError	Api error.

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

DedicatedHostAllocatableVM

Object

Represents the dedicated host unutilized capacity in terms of a specific VM size.

Name	Type	Description
count	number (double)	Maximum number of VMs of size vmSize that can fit in the dedicated host's remaining capacity.
vmSize	string	VM size in terms of which the unutilized capacity is represented.

DedicatedHostAvailableCapacity

Object

Dedicated host unutilized capacity.

Name	Type	Description
allocatableVMs	DedicatedHostAllocatableVM[]	The unutilized capacity of the dedicated host represented in terms of each VM size that is allowed to be deployed to the dedicated host.

DedicatedHostGroup

Object

Specifies information about the dedicated host group that the dedicated hosts should be assigned to. Currently, a dedicated host can only be added to a dedicated host group at creation time. An existing dedicated host cannot be added to another dedicated host group.

Name	Type	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	The geo-location where the resource lives
name	string	The name of the resource
properties.additionalCapabilities	DedicatedHostGroupPropertiesAdditionalCapabilities	Enables or disables a capability on the dedicated host group. Minimum api-version: 2022-03-01.
properties.hosts	SubResourceReadOnly[]	A list of references to all dedicated hosts in the dedicated host group.
properties.instanceView	DedicatedHostGroupInstanceView	The dedicated host group instance view, which has the list of instance view of the dedicated hosts under the dedicated host group.
properties.platformFaultDomainCount	integer (int32) minimum: 1	Number of fault domains that the host group can span.
properties.supportAutomaticPlacement	boolean	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.
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
zones	string[]	The availability zones.

DedicatedHostGroupInstanceView

Object

Name	Type	Description
hosts	DedicatedHostInstanceViewWithName[]	List of instance view of the dedicated hosts under the dedicated host group.

DedicatedHostGroupPropertiesAdditionalCapabilities

Object

Enables or disables a capability on the dedicated host group. Minimum api-version: 2022-03-01.

Name	Type	Description
ultraSSDEnabled	boolean	The flag that enables or disables a capability to have UltraSSD Enabled Virtual Machines on Dedicated Hosts of the Dedicated Host Group. For the Virtual Machines to be UltraSSD Enabled, UltraSSDEnabled flag for the resource needs to be set true as well. The value is defaulted to 'false' when not provided. Please refer to https://docs.microsoft.com/en-us/azure/virtual-machines/disks-enable-ultra-ssd for more details on Ultra SSD feature. Note: The ultraSSDEnabled setting can only be enabled for Host Groups that are created as zonal. Minimum api-version: 2022-03-01.

DedicatedHostInstanceViewWithName

Object

The instance view of a dedicated host that includes the name of the dedicated host. It is used for the response to the instance view of a dedicated host group.

Name	Type	Description
assetId	string	Specifies the unique id of the dedicated physical machine on which the dedicated host resides.
availableCapacity	DedicatedHostAvailableCapacity	Unutilized capacity of the dedicated host.
name	string	The name of the dedicated host.
statuses	InstanceViewStatus[]	The resource status information.

InnerError

Object

Inner error details.

Name	Type	Description
errordetail	string	The internal error message or exception dump.
exceptiontype	string	The exception type.

InstanceViewStatus

Object

Instance view status.

Name	Type	Description
code	string	The status code.
displayStatus	string	The short localizable label for the status.
level	StatusLevelTypes	The level code.
message	string	The detailed status message, including for alerts and error messages.
time	string (date-time)	The time of the status.

StatusLevelTypes

Enumeration

The level code.

Value	Description
Info
Warning
Error

SubResourceReadOnly

Object

Name	Type	Description
id	string	Resource Id

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string (date-time)	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.