Dedicated Hosts - Get

Reference

Service:: Compute

API Version:: 2024-03-01

Načte informace o vyhrazeném hostiteli.

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

With optional parameters:

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
hostGroupName	path	True	string	Název vyhrazené skupiny hostitelů.
hostName	path	True	string	Název vyhrazeného hostitele.
resourceGroupName	path	True	string	Název skupiny prostředků.
subscriptionId	path	True	string	Přihlašovací údaje předplatného, které jednoznačně identifikují předplatné Microsoft Azure. ID předplatného je součástí identifikátoru URI pro každé volání služby.
api-version	query	True	string	Verze rozhraní API klienta.
$expand	query		InstanceViewTypes	Výraz rozbalení, který se má použít na operaci. InstanceView načte seznam zobrazení instancí vyhrazeného hostitele. U vyhrazeného hostitele není podporována hodnota UserData.

Odpovědi

Name	Typ	Description
200 OK	DedicatedHost	OK
Other Status Codes	CloudError	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

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

Scopes

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

Get a dedicated host.

Sample Request

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/hostGroups/myDedicatedHostGroup/hosts/myHost?$expand=instanceView&api-version=2024-03-01


import com.azure.resourcemanager.compute.models.InstanceViewTypes;

/**
 * Samples for DedicatedHosts Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/
     * dedicatedHostExamples/DedicatedHost_Get.json
     */
    /**
     * Sample code: Get a dedicated host.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getADedicatedHost(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().manager().serviceClient().getDedicatedHosts().getWithResponse("myResourceGroup",
            "myDedicatedHostGroup", "myHost", InstanceViewTypes.INSTANCE_VIEW, 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

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_get.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="{subscriptionId}",
    )

    response = client.dedicated_hosts.get(
        resource_group_name="myResourceGroup",
        host_group_name="myDedicatedHostGroup",
        host_name="myHost",
    )
    print(response)


# x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/dedicatedHostExamples/DedicatedHost_Get.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

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/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_Get.json
func ExampleDedicatedHostsClient_Get() {
	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.NewDedicatedHostsClient().Get(ctx, "myResourceGroup", "myDedicatedHostGroup", "myHost", &armcompute.DedicatedHostsClientGetOptions{Expand: to.Ptr(armcompute.InstanceViewTypesInstanceView)})
	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.DedicatedHost = armcompute.DedicatedHost{
	// 	Name: to.Ptr("myHost"),
	// 	ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/HostGroups/myDedicatedHostGroup/hosts/myHost"),
	// 	Location: to.Ptr("westus"),
	// 	Tags: map[string]*string{
	// 		"department": to.Ptr("HR"),
	// 	},
	// 	Properties: &armcompute.DedicatedHostProperties{
	// 		AutoReplaceOnFailure: to.Ptr(true),
	// 		HostID: to.Ptr("{GUID}"),
	// 		InstanceView: &armcompute.DedicatedHostInstanceView{
	// 			AssetID: to.Ptr("eb3f58b8-b4e8-4882-b69f-301a01812407"),
	// 			AvailableCapacity: &armcompute.DedicatedHostAvailableCapacity{
	// 				AllocatableVMs: []*armcompute.DedicatedHostAllocatableVM{
	// 					{
	// 						Count: to.Ptr[float64](10),
	// 						VMSize: to.Ptr("Standard_A1"),
	// 				}},
	// 			},
	// 			Statuses: []*armcompute.InstanceViewStatus{
	// 				{
	// 					Code: to.Ptr("ProvisioningState/succeeded"),
	// 					DisplayStatus: to.Ptr("Provisioning succeeded"),
	// 					Level: to.Ptr(armcompute.StatusLevelTypesInfo),
	// 				},
	// 				{
	// 					Code: to.Ptr("HealthState/available"),
	// 					DisplayStatus: to.Ptr("Host available"),
	// 					Level: to.Ptr(armcompute.StatusLevelTypesInfo),
	// 			}},
	// 		},
	// 		PlatformFaultDomain: to.Ptr[int32](1),
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 		ProvisioningTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-06-27T01:02:38.313Z"); return t}()),
	// 		TimeCreated: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-06-27T01:02:38.313Z"); return t}()),
	// 		VirtualMachines: []*armcompute.SubResourceReadOnly{
	// 			{
	// 				ID: to.Ptr("/subscriptions/subId/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/vm1"),
	// 		}},
	// 	},
	// 	SKU: &armcompute.SKU{
	// 		Name: to.Ptr("DSv3-Type1"),
	// 	},
	// }
}

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

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

/**
 * This sample demonstrates how to Retrieves information about a dedicated host.
 *
 * @summary Retrieves information about a dedicated host.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/dedicatedHostExamples/DedicatedHost_Get.json
 */
async function getADedicatedHost() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscriptionId}";
  const resourceGroupName = process.env["COMPUTE_RESOURCE_GROUP"] || "myResourceGroup";
  const hostGroupName = "myDedicatedHostGroup";
  const hostName = "myHost";
  const expand = "instanceView";
  const options = { expand };
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.dedicatedHosts.get(
    resourceGroupName,
    hostGroupName,
    hostName,
    options,
  );
  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

Sample Response

Status code:: 200

{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/HostGroups/myDedicatedHostGroup/hosts/myHost",
  "properties": {
    "platformFaultDomain": 1,
    "autoReplaceOnFailure": true,
    "hostId": "{GUID}",
    "provisioningTime": "2019-06-27T01:02:38.3138469+00:00",
    "virtualMachines": [
      {
        "id": "/subscriptions/subId/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/vm1"
      }
    ],
    "provisioningState": "Succeeded",
    "instanceView": {
      "assetId": "eb3f58b8-b4e8-4882-b69f-301a01812407",
      "availableCapacity": {
        "allocatableVMs": [
          {
            "vmSize": "Standard_A1",
            "count": 10
          }
        ]
      },
      "statuses": [
        {
          "code": "ProvisioningState/succeeded",
          "level": "Info",
          "displayStatus": "Provisioning succeeded"
        },
        {
          "code": "HealthState/available",
          "level": "Info",
          "displayStatus": "Host available"
        }
      ]
    },
    "timeCreated": "2019-06-27T01:02:38.3138469+00:00"
  },
  "location": "westus",
  "tags": {
    "department": "HR"
  },
  "sku": {
    "name": "DSv3-Type1"
  },
  "name": "myHost"
}

Definice

Name	Description
ApiError	Chyba rozhraní API
ApiErrorBase	Základ chyb rozhraní API.
CloudError	Chybová odpověď ze služby Compute.
DedicatedHost	Určuje informace o vyhrazeném hostiteli.
DedicatedHostAllocatableVM	Představuje nevyužitou kapacitu vyhrazeného hostitele z hlediska konkrétní velikosti virtuálního počítače.
DedicatedHostAvailableCapacity	Nevyužitá kapacita vyhrazeného hostitele
DedicatedHostInstanceView	Zobrazení instance vyhrazeného hostitele.
DedicatedHostLicenseTypes	Určuje typ softwarové licence, která se použije na virtuální počítače nasazené na vyhrazeném hostiteli. Možné hodnoty jsou: Žádné,Windows_Server_Hybrid,Windows_Server_Perpetual. Výchozí hodnota je: Žádný.
InnerError	Podrobnosti o vnitřní chybě.
InstanceViewStatus	Stav zobrazení instance.
InstanceViewTypes	Výraz rozbalení, který se má použít na operaci. InstanceView načte seznam zobrazení instancí vyhrazeného hostitele. U vyhrazeného hostitele není podporována hodnota UserData.
Sku	Popisuje skladovou položku škálovací sady virtuálních počítačů. POZNÁMKA: Pokud se nová skladová položka virtuálního počítače nepodporuje na hardwaru, na který se škálovací sada aktuálně nachází, musíte před úpravou názvu skladové položky uvolnit virtuální počítače ve škálovací sadě.
StatusLevelTypes	Kód úrovně.
SubResourceReadOnly

ApiError

Chyba rozhraní API

Name	Typ	Description
code	string	Kód chyby
details	ApiErrorBase[]	Podrobnosti o chybě rozhraní API
innererror	InnerError	Vnitřní chyba rozhraní API
message	string	Chybová zpráva
target	string	Cíl konkrétní chyby.

ApiErrorBase

Základ chyb rozhraní API.

Name	Typ	Description
code	string	Kód chyby
message	string	Chybová zpráva
target	string	Cíl konkrétní chyby.

CloudError

Chybová odpověď ze služby Compute.

Name	Typ	Description
error	ApiError	Chyba rozhraní API

DedicatedHost

Určuje informace o vyhrazeném hostiteli.

Name	Typ	Description
id	string	ID prostředku
location	string	Umístění prostředku
name	string	Název prostředku
properties.autoReplaceOnFailure	boolean	Určuje, jestli má být vyhrazený hostitel v případě selhání automaticky nahrazen. Hodnota je ve výchozím nastavení true, pokud není zadaná.
properties.hostId	string	Jedinečné ID vygenerované a přiřazené vyhrazenému hostiteli platformou. Nemění se po celou dobu životnosti hostitele.
properties.instanceView	DedicatedHostInstanceView	Zobrazení vyhrazené instance hostitele
properties.licenseType	DedicatedHostLicenseTypes	Určuje typ softwarové licence, která se použije na virtuální počítače nasazené na vyhrazeném hostiteli. Možné hodnoty jsou: Žádné,Windows_Server_Hybrid,Windows_Server_Perpetual. Výchozí hodnota je: Žádný.
properties.platformFaultDomain	integer	Doména selhání vyhrazeného hostitele v rámci vyhrazené skupiny hostitelů
properties.provisioningState	string	Stav zřizování, který se zobrazí pouze v odpovědi.
properties.provisioningTime	string	Datum, kdy byl hostitel poprvé zřízen.
properties.timeCreated	string	Určuje čas vytvoření prostředku Dedicated Host. Minimální verze rozhraní API: 2021-11-01.
properties.virtualMachines	SubResourceReadOnly[]	Seznam odkazů na všechny virtuální počítače ve vyhrazeném hostiteli.
sku	Sku	Skladová položka vyhrazeného hostitele pro generaci hardwaru a řadu virtuálních počítačů. Je nutné nastavit pouze název. Seznam možných hodnot zobrazí seznam skladových položek Microsoft.Compute.
tags	object	Značky prostředků
type	string	Typ prostředku

DedicatedHostAllocatableVM

Představuje nevyužitou kapacitu vyhrazeného hostitele z hlediska konkrétní velikosti virtuálního počítače.

Name	Typ	Description
count	number	Maximální počet virtuálních počítačů o velikosti vmSize, které se vejdou do zbývající kapacity vyhrazeného hostitele.
vmSize	string	Velikost virtuálního počítače, ve které je vyjádřena nevyužitá kapacita.

DedicatedHostAvailableCapacity

Nevyužitá kapacita vyhrazeného hostitele

Name	Typ	Description
allocatableVMs	DedicatedHostAllocatableVM[]	Nevyužitá kapacita vyhrazeného hostitele vyjádřená z hlediska velikosti jednotlivých virtuálních počítačů, které je možné nasadit na vyhrazeného hostitele.

DedicatedHostInstanceView

Zobrazení instance vyhrazeného hostitele.

Name	Typ	Description
assetId	string	Určuje jedinečné ID vyhrazeného fyzického počítače, na kterém se nachází vyhrazený hostitel.
availableCapacity	DedicatedHostAvailableCapacity	Nevyužitá kapacita vyhrazeného hostitele.
statuses	InstanceViewStatus[]	Informace o stavu prostředku.

DedicatedHostLicenseTypes

Určuje typ softwarové licence, která se použije na virtuální počítače nasazené na vyhrazeném hostiteli. Možné hodnoty jsou: Žádné,Windows_Server_Hybrid,Windows_Server_Perpetual. Výchozí hodnota je: Žádný.

Name	Typ	Description
None	string
Windows_Server_Hybrid	string
Windows_Server_Perpetual	string

InnerError

Podrobnosti o vnitřní chybě.

Name	Typ	Description
errordetail	string	Vnitřní chybová zpráva nebo výpis výjimky.
exceptiontype	string	Typ výjimky.

InstanceViewStatus

Stav zobrazení instance.

Name	Typ	Description
code	string	Stavový kód.
displayStatus	string	Krátký lokalizovatelný popisek stavu.
level	StatusLevelTypes	Kód úrovně.
message	string	Podrobná stavová zpráva, včetně upozornění a chybových zpráv.
time	string	Čas stavu.

InstanceViewTypes

Výraz rozbalení, který se má použít na operaci. InstanceView načte seznam zobrazení instancí vyhrazeného hostitele. U vyhrazeného hostitele není podporována hodnota UserData.

Name	Typ	Description
instanceView	string
userData	string

Sku

Popisuje skladovou položku škálovací sady virtuálních počítačů. POZNÁMKA: Pokud se nová skladová položka virtuálního počítače nepodporuje na hardwaru, na který se škálovací sada aktuálně nachází, musíte před úpravou názvu skladové položky uvolnit virtuální počítače ve škálovací sadě.

Name	Typ	Description
capacity	integer	Určuje počet virtuálních počítačů ve škálovací sadě.
name	string	Název skladové položky.
tier	string	Určuje úroveň virtuálních počítačů ve škálovací sadě. Možné hodnoty: Standard Basic

StatusLevelTypes

Kód úrovně.

Name	Typ	Description
Error	string
Info	string
Warning	string

SubResourceReadOnly

Name	Typ	Description
id	string	ID prostředku

Dedicated Hosts - Get

Parametry identifikátoru URI

Odpovědi

Zabezpečení

azure_auth

Scopes

Příklady

Get a dedicated host.

Sample Request

Sample Response

Definice

ApiError

ApiErrorBase

CloudError

DedicatedHost

DedicatedHostAllocatableVM

DedicatedHostAvailableCapacity

DedicatedHostInstanceView

DedicatedHostLicenseTypes

InnerError

InstanceViewStatus

InstanceViewTypes

Sku

StatusLevelTypes

SubResourceReadOnly

Další materiály