Dedicated Hosts - List By Host Group

Odwołanie

Service:: Compute

API Version:: 2024-03-01

Listy wszystkich dedykowanych hostów w określonej dedykowanej grupie hostów. Użyj właściwości nextLink w odpowiedzi, aby uzyskać następną stronę dedykowanych hostów.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
hostGroupName	path	True	string	Nazwa dedykowanej grupy hostów.
resourceGroupName	path	True	string	Nazwa grupy zasobów.
subscriptionId	path	True	string	Poświadczenia subskrypcji, które jednoznacznie identyfikują subskrypcję platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora URI dla każdego wywołania usługi.
api-version	query	True	string	Wersja interfejsu API klienta.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	DedicatedHostListResult	OK
Other Status Codes	CloudError	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

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

Scopes

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

DedicatedHost_ListByHostGroup_MaximumSet_Gen

DedicatedHost_ListByHostGroup_MinimumSet_Gen

DedicatedHost_ListByHostGroup_MaximumSet_Gen

Sample Request

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


/**
 * Samples for DedicatedHosts ListByHostGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/
     * dedicatedHostExamples/DedicatedHost_ListByHostGroup_MaximumSet_Gen.json
     */
    /**
     * Sample code: DedicatedHost_ListByHostGroup_MaximumSet_Gen.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void dedicatedHostListByHostGroupMaximumSetGen(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().manager().serviceClient().getDedicatedHosts().listByHostGroup("rgcompute",
            "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", 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

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/v5"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/92de53a5f1e0e03c94b40475d2135d97148ed014/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/dedicatedHostExamples/DedicatedHost_ListByHostGroup_MaximumSet_Gen.json
func ExampleDedicatedHostsClient_NewListByHostGroupPager_dedicatedHostListByHostGroupMaximumSetGen() {
	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.NewDedicatedHostsClient().NewListByHostGroupPager("rgcompute", "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", 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.DedicatedHostListResult = armcompute.DedicatedHostListResult{
		// 	Value: []*armcompute.DedicatedHost{
		// 		{
		// 			Name: to.Ptr("myDedicatedHost"),
		// 			Type: to.Ptr("aaaaaaaaaaaaaaaaaaa"),
		// 			ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/HostGroups/myDedicatedHostGroup/hosts/myDedicatedHost"),
		// 			Location: to.Ptr("westus"),
		// 			Tags: map[string]*string{
		// 			},
		// 			Properties: &armcompute.DedicatedHostProperties{
		// 				AutoReplaceOnFailure: to.Ptr(true),
		// 				HostID: to.Ptr("{GUID}"),
		// 				InstanceView: &armcompute.DedicatedHostInstanceView{
		// 					AssetID: to.Ptr("aaaaaaaaaaaaaaaa"),
		// 					AvailableCapacity: &armcompute.DedicatedHostAvailableCapacity{
		// 						AllocatableVMs: []*armcompute.DedicatedHostAllocatableVM{
		// 							{
		// 								Count: to.Ptr[float64](26),
		// 								VMSize: to.Ptr("aaaaaaaaaaaaaaaaaaaa"),
		// 						}},
		// 					},
		// 					Statuses: []*armcompute.InstanceViewStatus{
		// 						{
		// 							Code: to.Ptr("aaaaaaaaaaaaaaaaaaaaaaa"),
		// 							DisplayStatus: to.Ptr("aaaaaa"),
		// 							Level: to.Ptr(armcompute.StatusLevelTypesInfo),
		// 							Message: to.Ptr("a"),
		// 							Time: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-11-30T12:58:26.522Z"); return t}()),
		// 					}},
		// 				},
		// 				LicenseType: to.Ptr(armcompute.DedicatedHostLicenseTypesWindowsServerHybrid),
		// 				PlatformFaultDomain: to.Ptr[int32](1),
		// 				ProvisioningState: to.Ptr("Succeeded"),
		// 				ProvisioningTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-11-30T12:58:26.526Z"); return t}()),
		// 				VirtualMachines: []*armcompute.SubResourceReadOnly{
		// 					{
		// 						ID: to.Ptr("aaaa"),
		// 				}},
		// 			},
		// 			SKU: &armcompute.SKU{
		// 				Name: to.Ptr("DSv3-Type1"),
		// 				Capacity: to.Ptr[int64](7),
		// 				Tier: to.Ptr("aaa"),
		// 			},
		// 	}},
		// }
	}
}

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

{
  "value": [
    {
      "location": "westus",
      "tags": {},
      "properties": {
        "platformFaultDomain": 1,
        "autoReplaceOnFailure": true,
        "hostId": "{GUID}",
        "virtualMachines": [
          {
            "id": "aaaa"
          }
        ],
        "licenseType": "Windows_Server_Hybrid",
        "provisioningTime": "2021-11-30T12:58:26.526Z",
        "provisioningState": "aaaaaaaaaaaaaaaaaaaaaaaaa",
        "instanceView": {
          "assetId": "aaaaaaaaaaaaaaaa",
          "availableCapacity": {
            "allocatableVMs": [
              {
                "vmSize": "aaaaaaaaaaaaaaaaaaaa",
                "count": 26
              }
            ]
          },
          "statuses": [
            {
              "code": "aaaaaaaaaaaaaaaaaaaaaaa",
              "level": "Info",
              "displayStatus": "aaaaaa",
              "message": "a",
              "time": "2021-11-30T12:58:26.522Z"
            }
          ]
        }
      },
      "sku": {
        "name": "DSv3-Type1",
        "tier": "aaa",
        "capacity": 7
      },
      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/HostGroups/myDedicatedHostGroup/hosts/myDedicatedHost",
      "name": "myDedicatedHost",
      "type": "aaaaaaaaaaaaaaaaaaa"
    }
  ],
  "nextLink": "aaaaaaa"
}

DedicatedHost_ListByHostGroup_MinimumSet_Gen

Sample Request

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


/**
 * Samples for DedicatedHosts ListByHostGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/
     * dedicatedHostExamples/DedicatedHost_ListByHostGroup_MinimumSet_Gen.json
     */
    /**
     * Sample code: DedicatedHost_ListByHostGroup_MinimumSet_Gen.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void dedicatedHostListByHostGroupMinimumSetGen(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().manager().serviceClient().getDedicatedHosts().listByHostGroup("rgcompute", "aaaa",
            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

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/v5"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/92de53a5f1e0e03c94b40475d2135d97148ed014/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/dedicatedHostExamples/DedicatedHost_ListByHostGroup_MinimumSet_Gen.json
func ExampleDedicatedHostsClient_NewListByHostGroupPager_dedicatedHostListByHostGroupMinimumSetGen() {
	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.NewDedicatedHostsClient().NewListByHostGroupPager("rgcompute", "aaaa", 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.DedicatedHostListResult = armcompute.DedicatedHostListResult{
		// 	Value: []*armcompute.DedicatedHost{
		// 		{
		// 			ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/HostGroups/myDedicatedHostGroup/hosts/myHost"),
		// 			Location: to.Ptr("westus"),
		// 			SKU: &armcompute.SKU{
		// 			},
		// 	}},
		// }
	}
}

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

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

Definicje

Nazwa	Opis
ApiError	Błąd interfejsu API.
ApiErrorBase	Baza błędów interfejsu API.
CloudError	Odpowiedź o błędzie z usługi Compute.
DedicatedHost	Określa informacje o dedykowanym hoście.
DedicatedHostAllocatableVM	Reprezentuje dedykowaną pojemność nieuprawnionego hosta pod względem określonego rozmiaru maszyny wirtualnej.
DedicatedHostAvailableCapacity	Dedykowana pojemność hosta nieuprawnionego.
DedicatedHostInstanceView	Widok wystąpienia dedykowanego hosta.
DedicatedHostLicenseTypes	Określa typ licencji oprogramowania, który zostanie zastosowany do maszyn wirtualnych wdrożonych na dedykowanym hoście. Możliwe wartości to: Brak,Windows_Server_Hybrid,Windows_Server_Perpetual. Wartość domyślna to: Brak.
DedicatedHostListResult	Lista dedykowana odpowiedź operacji hosta.
InnerError	Szczegóły błędu wewnętrznego.
InstanceViewStatus	Stan widoku wystąpienia.
Sku	Opisuje jednostkę SKU zestawu skalowania maszyn wirtualnych. UWAGA: Jeśli nowa jednostka SKU maszyny wirtualnej nie jest obecnie obsługiwana na sprzęcie, zestaw skalowania jest obecnie włączony, należy cofnąć przydział maszyn wirtualnych w zestawie skalowania przed zmodyfikowaniem nazwy jednostki SKU.
StatusLevelTypes	Kod poziomu.
SubResourceReadOnly

ApiError

Błąd interfejsu API.

Nazwa	Typ	Opis
code	string	Kod błędu.
details	ApiErrorBase[]	Szczegóły błędu interfejsu API
innererror	InnerError	Wewnętrzny błąd interfejsu API
message	string	Komunikat o błędzie.
target	string	Element docelowy określonego błędu.

ApiErrorBase

Baza błędów interfejsu API.

Nazwa	Typ	Opis
code	string	Kod błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy określonego błędu.

CloudError

Odpowiedź o błędzie z usługi Compute.

Nazwa	Typ	Opis
error	ApiError	Błąd interfejsu API.

DedicatedHost

Określa informacje o dedykowanym hoście.

Nazwa	Typ	Opis
id	string	Identyfikator zasobu
location	string	Lokalizacja zasobu
name	string	Nazwa zasobu
properties.autoReplaceOnFailure	boolean	Określa, czy dedykowany host powinien zostać automatycznie zastąpiony w przypadku awarii. Wartość jest domyślnie ustawiona na wartość "true", jeśli nie zostanie podana.
properties.hostId	string	Unikatowy identyfikator wygenerowany i przypisany do dedykowanego hosta przez platformę. Nie zmienia się przez cały okres istnienia hosta.
properties.instanceView	DedicatedHostInstanceView	Widok dedykowanego wystąpienia hosta.
properties.licenseType	DedicatedHostLicenseTypes	Określa typ licencji oprogramowania, który zostanie zastosowany do maszyn wirtualnych wdrożonych na dedykowanym hoście. Możliwe wartości to: Brak,Windows_Server_Hybrid,Windows_Server_Perpetual. Wartość domyślna to: Brak.
properties.platformFaultDomain	integer	Domena błędów dedykowanego hosta w dedykowanej grupie hostów.
properties.provisioningState	string	Stan aprowizacji, który pojawia się tylko w odpowiedzi.
properties.provisioningTime	string	Data pierwszej aprowizacji hosta.
properties.timeCreated	string	Określa czas utworzenia zasobu dedykowanego hosta. Minimalna wersja interfejsu API: 2021-11-01.
properties.virtualMachines	SubResourceReadOnly[]	Lista odwołań do wszystkich maszyn wirtualnych na dedykowanym hoście.
sku	Sku	Jednostka SKU dedykowanego hosta dla rodziny sprzętu i maszyn wirtualnych. Do ustawienia jest wymagana tylko nazwa. Wyświetl listę jednostek SKU Microsoft.Compute, aby uzyskać listę możliwych wartości.
tags	object	Tagi zasobów
type	string	Typ zasobu

DedicatedHostAllocatableVM

Reprezentuje dedykowaną pojemność nieuprawnionego hosta pod względem określonego rozmiaru maszyny wirtualnej.

Nazwa	Typ	Opis
count	number	Maksymalna liczba maszyn wirtualnych o rozmiarze vmSize, które mogą mieścić się w pozostałej pojemności dedykowanego hosta.
vmSize	string	Rozmiar maszyny wirtualnej, dla którego jest reprezentowana nieuprawnionej pojemności.

DedicatedHostAvailableCapacity

Dedykowana pojemność hosta nieuprawnionego.

Nazwa	Typ	Opis
allocatableVMs	DedicatedHostAllocatableVM[]	Nieuprawnionej pojemności dedykowanego hosta reprezentowanego pod względem każdego rozmiaru maszyny wirtualnej, który może zostać wdrożony na dedykowanym hoście.

DedicatedHostInstanceView

Widok wystąpienia dedykowanego hosta.

Nazwa	Typ	Opis
assetId	string	Określa unikatowy identyfikator dedykowanej maszyny fizycznej, na której znajduje się dedykowany host.
availableCapacity	DedicatedHostAvailableCapacity	Nieuprawnionej pojemności dedykowanego hosta.
statuses	InstanceViewStatus[]	Informacje o stanie zasobu.

DedicatedHostLicenseTypes

Określa typ licencji oprogramowania, który zostanie zastosowany do maszyn wirtualnych wdrożonych na dedykowanym hoście. Możliwe wartości to: Brak,Windows_Server_Hybrid,Windows_Server_Perpetual. Wartość domyślna to: Brak.

Nazwa	Typ	Opis
None	string
Windows_Server_Hybrid	string
Windows_Server_Perpetual	string

DedicatedHostListResult

Lista dedykowana odpowiedź operacji hosta.

Nazwa	Typ	Opis
nextLink	string	Identyfikator URI do pobrania następnej strony dedykowanych hostów. Wywołaj metodę ListNext() za pomocą tego identyfikatora URI, aby pobrać następną stronę dedykowanych hostów.
value	DedicatedHost[]	Lista dedykowanych hostów

InnerError

Szczegóły błędu wewnętrznego.

Nazwa	Typ	Opis
errordetail	string	Wewnętrzny komunikat o błędzie lub zrzut wyjątku.
exceptiontype	string	Typ wyjątku.

InstanceViewStatus

Stan widoku wystąpienia.

Nazwa	Typ	Opis
code	string	Kod stanu.
displayStatus	string	Krótka etykieta lokalizowalna dla stanu.
level	StatusLevelTypes	Kod poziomu.
message	string	Szczegółowy komunikat o stanie, w tym alerty i komunikaty o błędach.
time	string	Czas stanu.

Sku

Opisuje jednostkę SKU zestawu skalowania maszyn wirtualnych. UWAGA: Jeśli nowa jednostka SKU maszyny wirtualnej nie jest obecnie obsługiwana na sprzęcie, zestaw skalowania jest obecnie włączony, należy cofnąć przydział maszyn wirtualnych w zestawie skalowania przed zmodyfikowaniem nazwy jednostki SKU.

Nazwa	Typ	Opis
capacity	integer	Określa liczbę maszyn wirtualnych w zestawie skalowania.
name	string	Nazwa jednostki SKU.
tier	string	Określa warstwę maszyn wirtualnych w zestawie skalowania. Możliwe wartości: Standardowa Podstawowa

StatusLevelTypes

Kod poziomu.

Nazwa	Typ	Opis
Error	string
Info	string
Warning	string

SubResourceReadOnly

Nazwa	Typ	Opis
id	string	Identyfikator zasobu

Dedicated Hosts - List By Host Group

Parametry identyfikatora URI

Odpowiedzi

Zabezpieczenia

azure_auth

Scopes

Przykłady

DedicatedHost_ListByHostGroup_MaximumSet_Gen

Sample Request

Sample Response

DedicatedHost_ListByHostGroup_MinimumSet_Gen

Sample Request

Sample Response

Definicje

ApiError

ApiErrorBase

CloudError

DedicatedHost

DedicatedHostAllocatableVM

DedicatedHostAvailableCapacity

DedicatedHostInstanceView

DedicatedHostLicenseTypes

DedicatedHostListResult

InnerError

InstanceViewStatus

Sku

StatusLevelTypes

SubResourceReadOnly

Dodatkowe zasoby