Dedicated Hosts - Get

Referens

Service:: Compute

API Version:: 2024-03-01

Hämtar information om en dedikerad värd.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
hostGroupName	path	True	string	Namnet på den dedikerade värdgruppen.
hostName	path	True	string	Namnet på den dedikerade värden.
resourceGroupName	path	True	string	Namnet på resursgruppen.
subscriptionId	path	True	string	Autentiseringsuppgifter för prenumeration som unikt identifierar Microsoft Azure-prenumeration. Prenumerations-ID:t utgör en del av URI:n för varje tjänstanrop.
api-version	query	True	string	Klient-API-version.
$expand	query		InstanceViewTypes	Expanderingsuttrycket som ska tillämpas på åtgärden. "InstanceView" hämtar listan över instansvyer för den dedikerade värden. UserData stöds inte för dedikerad värd.

Svar

Name	Typ	Description
200 OK	DedicatedHost	OK
Other Status Codes	CloudError	Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

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	personifiera ditt användarkonto

Exempel

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"
}

Definitioner

Name	Description
ApiError	API-fel.
ApiErrorBase	Api-felbas.
CloudError	Ett felsvar från Beräkningstjänsten.
DedicatedHost	Anger information om den dedikerade värden.
DedicatedHostAllocatableVM	Representerar den dedikerade värdkapaciteten som inte används i termer av en specifik VM-storlek.
DedicatedHostAvailableCapacity	Ej utnyttjad kapacitet för dedikerad värd.
DedicatedHostInstanceView	Instansvyn för en dedikerad värd.
DedicatedHostLicenseTypes	Anger vilken typ av programvarulicens som ska tillämpas på de virtuella datorer som distribueras på den dedikerade värden. Möjliga värden är: None,Windows_Server_Hybrid,Windows_Server_Perpetual. Standardvärdet är: Ingen.
InnerError	Inre felinformation.
InstanceViewStatus	Status för instansvyn.
InstanceViewTypes	Expanderingsuttrycket som ska tillämpas på åtgärden. "InstanceView" hämtar listan över instansvyer för den dedikerade värden. UserData stöds inte för dedikerad värd.
Sku	Beskriver en SKU för VM-skalningsuppsättningar. Obs! Om den nya VM-SKU:n inte stöds på maskinvaran som skalningsuppsättningen för närvarande är på, måste du frigöra de virtuella datorerna i skalningsuppsättningen innan du ändrar SKU-namnet.
StatusLevelTypes	Nivåkoden.
SubResourceReadOnly

ApiError

API-fel.

Name	Typ	Description
code	string	Felkoden.
details	ApiErrorBase[]	Api-felinformationen
innererror	InnerError	Api:ets inre fel
message	string	Felmeddelandet.
target	string	Målet för det specifika felet.

ApiErrorBase

Api-felbas.

Name	Typ	Description
code	string	Felkoden.
message	string	Felmeddelandet.
target	string	Målet för det specifika felet.

CloudError

Ett felsvar från Beräkningstjänsten.

Name	Typ	Description
error	ApiError	API-fel.

DedicatedHost

Anger information om den dedikerade värden.

Name	Typ	Description
id	string	Resurs-ID
location	string	Resursplats
name	string	Resursnamn
properties.autoReplaceOnFailure	boolean	Anger om den dedikerade värden ska ersättas automatiskt vid fel. Värdet är som standard "true" när det inte anges.
properties.hostId	string	Ett unikt ID som genereras och tilldelas till den dedikerade värden av plattformen. Ändras inte under värdens livslängd.
properties.instanceView	DedicatedHostInstanceView	Vyn för den dedikerade värdinstansen.
properties.licenseType	DedicatedHostLicenseTypes	Anger vilken typ av programvarulicens som ska tillämpas på de virtuella datorer som distribueras på den dedikerade värden. Möjliga värden är: None,Windows_Server_Hybrid,Windows_Server_Perpetual. Standardvärdet är: Ingen.
properties.platformFaultDomain	integer	Feldomän för den dedikerade värden i en dedikerad värdgrupp.
properties.provisioningState	string	Etableringstillståndet, som bara visas i svaret.
properties.provisioningTime	string	Det datum då värden först etablerades.
properties.timeCreated	string	Anger den tidpunkt då den dedikerade värdresursen skapades. Lägsta API-version: 2021-11-01.
properties.virtualMachines	SubResourceReadOnly[]	En lista med referenser till alla virtuella datorer i den dedikerade värden.
sku	Sku	SKU för den dedikerade värden för maskinvarugenerering och VM-familj. Endast namn krävs för att anges. Lista Microsoft.Compute-SKU:er för en lista över möjliga värden.
tags	object	Resurstaggar
type	string	Resurstyp

DedicatedHostAllocatableVM

Representerar den dedikerade värdkapaciteten som inte används i termer av en specifik VM-storlek.

Name	Typ	Description
count	number	Maximalt antal virtuella datorer av storlek vmSize som får plats i den dedikerade värdens återstående kapacitet.
vmSize	string	Vm-storlek som den outnyttvända kapaciteten representeras av.

DedicatedHostAvailableCapacity

Ej utnyttjad kapacitet för dedikerad värd.

Name	Typ	Description
allocatableVMs	DedicatedHostAllocatableVM[]	Den outnyttvända kapaciteten för den dedikerade värden representeras av varje VM-storlek som tillåts distribueras till den dedikerade värden.

DedicatedHostInstanceView

Instansvyn för en dedikerad värd.

Name	Typ	Description
assetId	string	Anger det unika ID:t för den dedikerade fysiska dator där den dedikerade värden finns.
availableCapacity	DedicatedHostAvailableCapacity	Outnyttkommen kapacitet för den dedikerade värden.
statuses	InstanceViewStatus[]	Resursstatusinformationen.

DedicatedHostLicenseTypes

Anger vilken typ av programvarulicens som ska tillämpas på de virtuella datorer som distribueras på den dedikerade värden. Möjliga värden är: None,Windows_Server_Hybrid,Windows_Server_Perpetual. Standardvärdet är: Ingen.

Name	Typ	Description
None	string
Windows_Server_Hybrid	string
Windows_Server_Perpetual	string

InnerError

Inre felinformation.

Name	Typ	Description
errordetail	string	Det interna felmeddelandet eller undantagsdumpen.
exceptiontype	string	Undantagstypen.

InstanceViewStatus

Status för instansvyn.

Name	Typ	Description
code	string	Statuskoden.
displayStatus	string	Den korta localizable-etiketten för statusen.
level	StatusLevelTypes	Nivåkoden.
message	string	Det detaljerade statusmeddelandet, inklusive för aviseringar och felmeddelanden.
time	string	Tidpunkten för statusen.

InstanceViewTypes

Expanderingsuttrycket som ska tillämpas på åtgärden. "InstanceView" hämtar listan över instansvyer för den dedikerade värden. UserData stöds inte för dedikerad värd.

Name	Typ	Description
instanceView	string
userData	string

Sku

Beskriver en SKU för VM-skalningsuppsättningar. Obs! Om den nya VM-SKU:n inte stöds på maskinvaran som skalningsuppsättningen för närvarande är på, måste du frigöra de virtuella datorerna i skalningsuppsättningen innan du ändrar SKU-namnet.

Name	Typ	Description
capacity	integer	Anger antalet virtuella datorer i skalningsuppsättningen.
name	string	SKU-namnet.
tier	string	Anger nivån för virtuella datorer i en skalningsuppsättning. Möjliga värden: Standard Basic

StatusLevelTypes

Nivåkoden.

Name	Typ	Description
Error	string
Info	string
Warning	string

SubResourceReadOnly

Name	Typ	Description
id	string	Resurs-ID

Dedicated Hosts - Get

URI-parametrar

Svar

Säkerhet

azure_auth

Scopes

Exempel

Get a dedicated host.

Sample Request

Sample Response

Definitioner

ApiError

ApiErrorBase

CloudError

DedicatedHost

DedicatedHostAllocatableVM

DedicatedHostAvailableCapacity

DedicatedHostInstanceView

DedicatedHostLicenseTypes

InnerError

InstanceViewStatus

InstanceViewTypes

Sku

StatusLevelTypes

SubResourceReadOnly

Ytterligare resurser