Dedicated Host Groups - List By Resource Group

Serviço:

Compute

Versão da API:

2026-03-01

Lista todos os grupos de hosts dedicados no grupo de recursos especificado. Use a propriedade nextLink na resposta para obter a próxima página de grupos de hosts dedicados.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups?api-version=2026-03-01

Parâmetros do URI

Name	Em	Obrigatório	Tipo	Descrição
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
subscriptionId	path	True	string minLength: 1	O ID da assinatura de destino.
api-version	query	True	string minLength: 1	A versão da API a utilizar para esta operação.

Respostas

Name	Tipo	Descrição
200 OK	DedicatedHostGroupListResult	O pedido foi bem-sucedido.
Other Status Codes	CloudError	Uma resposta de erro inesperada.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Descrição
user_impersonation	assumir a identidade da sua conta de utilizador

Exemplos

DedicatedHostGroup_ListByResourceGroup_MaximumSet_Gen

DedicatedHostGroup_ListByResourceGroup_MinimumSet_Gen

DedicatedHostGroup_ListByResourceGroup_MaximumSet_Gen

Pedido de amostra

HTTP

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/hostGroups?api-version=2026-03-01

Java

/**
 * Samples for DedicatedHostGroups ListByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file: 2026-03-01/dedicatedHostExamples/DedicatedHostGroup_ListByResourceGroup_MaximumSet_Gen.json
     */
    /**
     * Sample code: DedicatedHostGroup_ListByResourceGroup_MaximumSet_Gen.
     * 
     * @param manager Entry point to ComputeManager.
     */
    public static void
        dedicatedHostGroupListByResourceGroupMaximumSetGen(com.azure.resourcemanager.compute.ComputeManager manager) {
        manager.serviceClient().getDedicatedHostGroups().listByResourceGroup("rgcompute",
            com.azure.core.util.Context.NONE);
    }
}

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_list_by_resource_group_maximum_set_gen.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.list_by_resource_group(
        resource_group_name="rgcompute",
    )
    for item in response:
        print(item)


# x-ms-original-file: 2026-03-01/dedicatedHostExamples/DedicatedHostGroup_ListByResourceGroup_MaximumSet_Gen.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/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/compute/armcompute/v8"
)

// Generated from example definition: 2026-03-01/dedicatedHostExamples/DedicatedHostGroup_ListByResourceGroup_MaximumSet_Gen.json
func ExampleDedicatedHostGroupsClient_NewListByResourceGroupPager_dedicatedHostGroupListByResourceGroupMaximumSetGen() {
	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)
	}
	pager := clientFactory.NewDedicatedHostGroupsClient().NewListByResourceGroupPager("rgcompute", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page = armcompute.DedicatedHostGroupsClientListByResourceGroupResponse{
		// 	DedicatedHostGroupListResult: armcompute.DedicatedHostGroupListResult{
		// 		Value: []*armcompute.DedicatedHostGroup{
		// 			{
		// 				Location: to.Ptr("westus"),
		// 				Tags: map[string]*string{
		// 				},
		// 				Zones: []*string{
		// 					to.Ptr("1"),
		// 				},
		// 				Properties: &armcompute.DedicatedHostGroupProperties{
		// 					PlatformFaultDomainCount: to.Ptr[int32](3),
		// 					SupportAutomaticPlacement: to.Ptr(true),
		// 					Hosts: []*armcompute.SubResourceReadOnly{
		// 						{
		// 							ID: to.Ptr("aaaa"),
		// 						},
		// 					},
		// 					InstanceView: &armcompute.DedicatedHostGroupInstanceView{
		// 						Hosts: []*armcompute.DedicatedHostInstanceViewWithName{
		// 							{
		// 								Name: to.Ptr("aaaaaaaaaaaaaaaaaa"),
		// 								AssetID: to.Ptr("aaaa"),
		// 								AvailableCapacity: &armcompute.DedicatedHostAvailableCapacity{
		// 									AllocatableVMs: []*armcompute.DedicatedHostAllocatableVM{
		// 										{
		// 											VMSize: to.Ptr("aaaaaaaaaaaaaaaaaaaa"),
		// 											Count: to.Ptr[float64](26),
		// 										},
		// 									},
		// 								},
		// 								Statuses: []*armcompute.InstanceViewStatus{
		// 									{
		// 										Code: to.Ptr("aaaaaaaaaaaaaaaaaaaaaaa"),
		// 										Level: to.Ptr(armcompute.StatusLevelTypesInfo),
		// 										DisplayStatus: to.Ptr("aaaaaa"),
		// 										Message: to.Ptr("a"),
		// 										Time: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-11-30T12:58:26.522Z"); return t}()),
		// 									},
		// 								},
		// 							},
		// 						},
		// 					},
		// 				},
		// 				ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/HostGroups/myDedicatedHostGroup"),
		// 				Name: to.Ptr("myDedicatedHostGroup"),
		// 				Type: to.Ptr("aaaa"),
		// 			},
		// 		},
		// 		NextLink: to.Ptr("a://example.com/aaaaaaaaaaaaaaaaaaaaaaaaaaa"),
		// 	},
		// }
	}
}

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 lists all of the dedicated host groups in the specified resource group. Use the nextLink property in the response to get the next page of dedicated host groups.
 *
 * @summary lists all of the dedicated host groups in the specified resource group. Use the nextLink property in the response to get the next page of dedicated host groups.
 * x-ms-original-file: 2026-03-01/dedicatedHostExamples/DedicatedHostGroup_ListByResourceGroup_MaximumSet_Gen.json
 */
async function dedicatedHostGroupListByResourceGroupMaximumSetGen() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "{subscription-id}";
  const client = new ComputeManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.dedicatedHostGroups.listByResourceGroup("rgcompute")) {
    resArray.push(item);
  }

  console.log(resArray);
}

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

Resposta da amostra

Código de estado:

200

{
  "value": [
    {
      "location": "westus",
      "tags": {},
      "zones": [
        "1"
      ],
      "properties": {
        "platformFaultDomainCount": 3,
        "supportAutomaticPlacement": true,
        "hosts": [
          {
            "id": "aaaa"
          }
        ],
        "instanceView": {
          "hosts": [
            {
              "name": "aaaaaaaaaaaaaaaaaa",
              "assetId": "aaaa",
              "availableCapacity": {
                "allocatableVMs": [
                  {
                    "vmSize": "aaaaaaaaaaaaaaaaaaaa",
                    "count": 26
                  }
                ]
              },
              "statuses": [
                {
                  "code": "aaaaaaaaaaaaaaaaaaaaaaa",
                  "level": "Info",
                  "displayStatus": "aaaaaa",
                  "message": "a",
                  "time": "2021-11-30T12:58:26.522Z"
                }
              ]
            }
          ]
        }
      },
      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/HostGroups/myDedicatedHostGroup",
      "name": "myDedicatedHostGroup",
      "type": "aaaa"
    }
  ],
  "nextLink": "a://example.com/aaaaaaaaaaaaaaaaaaaaaaaaaaa"
}

DedicatedHostGroup_ListByResourceGroup_MinimumSet_Gen

Pedido de amostra

HTTP

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/hostGroups?api-version=2026-03-01

Java

/**
 * Samples for DedicatedHostGroups ListByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file: 2026-03-01/dedicatedHostExamples/DedicatedHostGroup_ListByResourceGroup_MinimumSet_Gen.json
     */
    /**
     * Sample code: DedicatedHostGroup_ListByResourceGroup_MinimumSet_Gen.
     * 
     * @param manager Entry point to ComputeManager.
     */
    public static void
        dedicatedHostGroupListByResourceGroupMinimumSetGen(com.azure.resourcemanager.compute.ComputeManager manager) {
        manager.serviceClient().getDedicatedHostGroups().listByResourceGroup("rgcompute",
            com.azure.core.util.Context.NONE);
    }
}

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_list_by_resource_group_minimum_set_gen.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.list_by_resource_group(
        resource_group_name="rgcompute",
    )
    for item in response:
        print(item)


# x-ms-original-file: 2026-03-01/dedicatedHostExamples/DedicatedHostGroup_ListByResourceGroup_MinimumSet_Gen.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/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/compute/armcompute/v8"
)

// Generated from example definition: 2026-03-01/dedicatedHostExamples/DedicatedHostGroup_ListByResourceGroup_MinimumSet_Gen.json
func ExampleDedicatedHostGroupsClient_NewListByResourceGroupPager_dedicatedHostGroupListByResourceGroupMinimumSetGen() {
	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)
	}
	pager := clientFactory.NewDedicatedHostGroupsClient().NewListByResourceGroupPager("rgcompute", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page = armcompute.DedicatedHostGroupsClientListByResourceGroupResponse{
		// 	DedicatedHostGroupListResult: armcompute.DedicatedHostGroupListResult{
		// 		Value: []*armcompute.DedicatedHostGroup{
		// 			{
		// 				ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/HostGroups/myDedicatedHostGroup"),
		// 				Location: to.Ptr("westus"),
		// 			},
		// 		},
		// 	},
		// }
	}
}

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 lists all of the dedicated host groups in the specified resource group. Use the nextLink property in the response to get the next page of dedicated host groups.
 *
 * @summary lists all of the dedicated host groups in the specified resource group. Use the nextLink property in the response to get the next page of dedicated host groups.
 * x-ms-original-file: 2026-03-01/dedicatedHostExamples/DedicatedHostGroup_ListByResourceGroup_MinimumSet_Gen.json
 */
async function dedicatedHostGroupListByResourceGroupMinimumSetGen() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "{subscription-id}";
  const client = new ComputeManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.dedicatedHostGroups.listByResourceGroup("rgcompute")) {
    resArray.push(item);
  }

  console.log(resArray);
}

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

Resposta da amostra

Código de estado:

200

{
  "value": [
    {
      "id": "/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/HostGroups/myDedicatedHostGroup",
      "location": "westus"
    }
  ]
}

Definições

Name	Descrição
ApiError	Erro de api.
ApiErrorBase	Base de erro da api.
CloudError	Uma resposta de erro do serviço de computação.
createdByType	O tipo de identidade que criou o recurso.
DedicatedHostAllocatableVM	Representa a capacidade não utilizada do host dedicado em termos de um tamanho de VM específico.
DedicatedHostAvailableCapacity	Capacidade não utilizada do host dedicado.
DedicatedHostGroup	Especifica informações sobre o grupo de hosts dedicados ao qual os hosts dedicados devem ser atribuídos. Atualmente, um host dedicado só pode ser adicionado a um grupo de hosts dedicado no momento da criação. Um host dedicado existente não pode ser adicionado a outro grupo de hosts dedicado.
DedicatedHostGroupInstanceView
DedicatedHostGroupListResult	A Lista Grupo de Hosts Dedicados com resposta do grupo de recursos.
DedicatedHostGroupPropertiesAdditionalCapabilities	Habilita ou desabilita um recurso no grupo de hosts dedicado. Versão mínima api: 2022-03-01.
DedicatedHostInstanceViewWithName	A exibição de instância de um host dedicado que inclui o nome do host dedicado. Ele é usado para a resposta à exibição de instância de um grupo de hosts dedicado.
InnerError	Detalhes do erro interno.
InstanceViewStatus	Status da exibição da instância.
StatusLevelTypes	O código de nível.
SubResourceReadOnly
systemData	Metadados referentes à criação e última modificação do recurso.

ApiError

Object

Erro de api.

Name	Tipo	Descrição
code	string	O código de erro.
details	ApiErrorBase[]	Os detalhes do erro Api
innererror	InnerError	O erro interno da Api
message	string	A mensagem de erro.
target	string	O alvo do erro específico.

ApiErrorBase

Object

Base de erro da api.

Name	Tipo	Descrição
code	string	O código de erro.
message	string	A mensagem de erro.
target	string	O alvo do erro específico.

CloudError

Object

Uma resposta de erro do serviço de computação.

Name	Tipo	Descrição
error	ApiError	Erro de api.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Descrição
User
Application
ManagedIdentity
Key

DedicatedHostAllocatableVM

Object

Representa a capacidade não utilizada do host dedicado em termos de um tamanho de VM específico.

Name	Tipo	Descrição
count	number (double)	Número máximo de VMs de tamanho vmSize que podem caber na capacidade restante do host dedicado.
vmSize	string	Tamanho da VM em termos do qual a capacidade não utilizada é representada.

DedicatedHostAvailableCapacity

Object

Capacidade não utilizada do host dedicado.

Name	Tipo	Descrição
allocatableVMs	DedicatedHostAllocatableVM[]	A capacidade não utilizada do host dedicado representada em termos de cada tamanho de VM que pode ser implantado no host dedicado.

DedicatedHostGroup

Object

Especifica informações sobre o grupo de hosts dedicados ao qual os hosts dedicados devem ser atribuídos. Atualmente, um host dedicado só pode ser adicionado a um grupo de hosts dedicado no momento da criação. Um host dedicado existente não pode ser adicionado a outro grupo de hosts dedicado.

Name	Tipo	Descrição
id	string	ID de recurso totalmente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	A geolocalização onde o recurso vive
name	string	O nome do recurso
properties.additionalCapabilities	DedicatedHostGroupPropertiesAdditionalCapabilities	Habilita ou desabilita um recurso no grupo de hosts dedicado. Versão mínima api: 2022-03-01.
properties.hosts	SubResourceReadOnly[]	Uma lista de referências a todos os anfitriões dedicados no grupo de anfitriões dedicados.
properties.instanceView	DedicatedHostGroupInstanceView	A exibição de instância de grupo de host dedicado, que tem a exibição de lista de instância dos hosts dedicados sob o grupo de hosts dedicado.
properties.platformFaultDomainCount	integer (int32) minimum: 1	Número de domínios de falha que o grupo de hosts pode abranger.
properties.supportAutomaticPlacement	boolean	Especifica se máquinas virtuais ou conjuntos de dimensionamento de máquinas virtuais podem ser colocados automaticamente no grupo de hosts dedicados. Posicionamento automático significa que os recursos são alocados em hosts dedicados, que são escolhidos pelo Azure, sob o grupo de hosts dedicados. O valor é padronizado para 'false' quando não fornecido. Versão api mínima: 2020-06-01.
systemData	systemData	Metadados do Azure Resource Manager contendo informações createdBy e modifiedBy.
tags	object	Tags de recursos.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"
zones	string[]	As zonas de disponibilidade.

DedicatedHostGroupInstanceView

Object

Name	Tipo	Descrição
hosts	DedicatedHostInstanceViewWithName[]	Lista de exibição de instância dos hosts dedicados sob o grupo de hosts dedicados.

DedicatedHostGroupListResult

Object

A Lista Grupo de Hosts Dedicados com resposta do grupo de recursos.

Name	Tipo	Descrição
nextLink	string (uri)	O URI para buscar a próxima página de Grupos de Host Dedicados. Chame ListNext() com este URI para buscar a próxima página de Grupos de Host Dedicados.
value	DedicatedHostGroup[]	A lista de grupos de anfitriões dedicados.

DedicatedHostGroupPropertiesAdditionalCapabilities

Object

Habilita ou desabilita um recurso no grupo de hosts dedicado. Versão mínima api: 2022-03-01.

Name	Tipo	Descrição
ultraSSDEnabled	boolean	O sinalizador que habilita ou desabilita um recurso para ter máquinas virtuais habilitadas para UltraSSD em hosts dedicados do grupo de hosts dedicados. Para que as máquinas virtuais sejam habilitadas para UltraSSD, o sinalizador UltraSSDEnabled para o recurso também precisa ser definido como true. O valor é padronizado para 'false' quando não fornecido. Consulte para obter mais detalhes sobre o https://docs.microsoft.com/en-us/azure/virtual-machines/disks-enable-ultra-ssd recurso Ultra SSD. Nota: A configuração ultraSSDEnabled só pode ser habilitada para Grupos de Host criados como zonais. Versão mínima api: 2022-03-01.

DedicatedHostInstanceViewWithName

Object

A exibição de instância de um host dedicado que inclui o nome do host dedicado. Ele é usado para a resposta à exibição de instância de um grupo de hosts dedicado.

Name	Tipo	Descrição
assetId	string	Especifica a id exclusiva da máquina física dedicada na qual o host dedicado reside.
availableCapacity	DedicatedHostAvailableCapacity	Capacidade não utilizada do host dedicado.
name	string	O nome do host dedicado.
statuses	InstanceViewStatus[]	As informações de status do recurso.

InnerError

Object

Detalhes do erro interno.

Name	Tipo	Descrição
errordetail	string	A mensagem de erro interna ou despejo de exceção.
exceptiontype	string	O tipo de exceção.

InstanceViewStatus

Object

Status da exibição da instância.

Name	Tipo	Descrição
code	string	O código de status.
displayStatus	string	O rótulo curto localizável para o status.
level	StatusLevelTypes	O código de nível.
message	string	A mensagem de status detalhada, inclusive para alertas e mensagens de erro.
time	string (date-time)	A hora do status.

StatusLevelTypes

Enumeração

O código de nível.

Valor	Descrição
Info
Warning
Error

SubResourceReadOnly

Object

Name	Tipo	Descrição
id	string	ID do recurso

systemData

Object

Metadados referentes à criação e última modificação do recurso.

Name	Tipo	Descrição
createdAt	string (date-time)	A marca temporal da criação do recurso (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	A data e hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.