Dedicated Hosts - Get

Référence

Service:: Compute

API Version:: 2024-03-01

Récupère des informations sur un hôte dédié.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
hostGroupName	path	True	string	Nom du groupe hôte dédié.
hostName	path	True	string	Nom de l’hôte dédié.
resourceGroupName	path	True	string	Nom du groupe de ressources.
subscriptionId	path	True	string	Informations d’identification d’abonnement qui identifient de manière unique l’abonnement Microsoft Azure. L’ID d’abonnement fait partie de l’URI pour chaque appel de service.
api-version	query	True	string	Version de l’API cliente.
$expand	query		InstanceViewTypes	Expression de développement à appliquer à l’opération. 'InstanceView' récupère la liste des vues instance de l’hôte dédié. 'UserData' n’est pas pris en charge pour l’hôte dédié.

Réponses

Nom	Type	Description
200 OK	DedicatedHost	Ok
Other Status Codes	CloudError	Réponse d’erreur décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

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

Scopes

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Exemples

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

Définitions

Nom	Description
ApiError	Erreur d’API.
ApiErrorBase	Base d’erreurs de l’API.
CloudError	Réponse d’erreur du service de calcul.
DedicatedHost	Spécifie des informations sur l’hôte dédié.
DedicatedHostAllocatableVM	Représente la capacité non utilisée de l’hôte dédié en termes de taille de machine virtuelle spécifique.
DedicatedHostAvailableCapacity	Capacité non utilisée de l’hôte dédié.
DedicatedHostInstanceView	Vue instance d’un hôte dédié.
DedicatedHostLicenseTypes	Spécifie le type de licence logicielle qui sera appliqué aux machines virtuelles déployées sur l’hôte dédié. Les valeurs possibles sont : None,Windows_Server_Hybrid,Windows_Server_Perpetual. La valeur par défaut est : None.
InnerError	Détails internes de l’erreur.
InstanceViewStatus	Vue d’instance status.
InstanceViewTypes	Expression de développement à appliquer à l’opération. 'InstanceView' récupère la liste des vues instance de l’hôte dédié. 'UserData' n’est pas pris en charge pour l’hôte dédié.
Sku	Décrit une référence sku de groupe de machines virtuelles identiques. REMARQUE : Si la nouvelle référence SKU de machine virtuelle n’est pas prise en charge sur le matériel sur lequel se trouve actuellement le groupe identique, vous devez libérer les machines virtuelles dans le groupe identique avant de modifier le nom de la référence SKU.
StatusLevelTypes	Code de niveau.
SubResourceReadOnly

ApiError

Erreur d’API.

Nom	Type	Description
code	string	Code d'erreur.
details	ApiErrorBase[]	Détails de l’erreur api
innererror	InnerError	Erreur interne de l’API
message	string	Message d’erreur.
target	string	Cible de l’erreur particulière.

ApiErrorBase

Base d’erreurs de l’API.

Nom	Type	Description
code	string	Code d'erreur.
message	string	Message d’erreur.
target	string	Cible de l’erreur particulière.

CloudError

Réponse d’erreur du service de calcul.

Nom	Type	Description
error	ApiError	Erreur d’API.

DedicatedHost

Spécifie des informations sur l’hôte dédié.

Nom	Type	Description
id	string	ID de ressource
location	string	Emplacement de la ressource
name	string	Nom de la ressource
properties.autoReplaceOnFailure	boolean	Spécifie si l’hôte dédié doit être remplacé automatiquement en cas de défaillance. La valeur par défaut est « true » lorsqu’elle n’est pas fournie.
properties.hostId	string	ID unique généré et affecté à l’hôte dédié par la plateforme. Ne change pas pendant toute la durée de vie de l’hôte.
properties.instanceView	DedicatedHostInstanceView	Affichage instance hôte dédié.
properties.licenseType	DedicatedHostLicenseTypes	Spécifie le type de licence logicielle qui sera appliqué aux machines virtuelles déployées sur l’hôte dédié. Les valeurs possibles sont : None,Windows_Server_Hybrid,Windows_Server_Perpetual. La valeur par défaut est : None.
properties.platformFaultDomain	integer	Domaine d’erreur de l’hôte dédié au sein d’un groupe hôte dédié.
properties.provisioningState	string	État d’approvisionnement, qui apparaît uniquement dans la réponse.
properties.provisioningTime	string	Date à laquelle l’hôte a été approvisionné pour la première fois.
properties.timeCreated	string	Spécifie l’heure à laquelle la ressource d’hôte dédié a été créée. Version minimale de l’api : 01/11/2021.
properties.virtualMachines	SubResourceReadOnly[]	Liste des références à toutes les machines virtuelles dans l’hôte dédié.
sku	Sku	Référence SKU de l’hôte dédié pour la génération de matériel et la famille de machines virtuelles. Seul le nom doit être défini. Répertoriez les références SKU Microsoft.Compute pour obtenir la liste des valeurs possibles.
tags	object	Balises de ressource
type	string	Type de ressource

DedicatedHostAllocatableVM

Représente la capacité non utilisée de l’hôte dédié en termes de taille de machine virtuelle spécifique.

Nom	Type	Description
count	number	Nombre maximal de machines virtuelles de taille vmSize pouvant tenir dans la capacité restante de l’hôte dédié.
vmSize	string	Taille de machine virtuelle en termes de représentation de la capacité non utilisée.

DedicatedHostAvailableCapacity

Capacité non utilisée de l’hôte dédié.

Nom	Type	Description
allocatableVMs	DedicatedHostAllocatableVM[]	Capacité inutilisée de l’hôte dédié représenté en termes de taille de machine virtuelle autorisée à être déployée sur l’hôte dédié.

DedicatedHostInstanceView

Vue instance d’un hôte dédié.

Nom	Type	Description
assetId	string	Spécifie l’ID unique de l’ordinateur physique dédié sur lequel réside l’hôte dédié.
availableCapacity	DedicatedHostAvailableCapacity	Capacité non utilisée de l’hôte dédié.
statuses	InstanceViewStatus[]	La ressource status informations.

DedicatedHostLicenseTypes

Spécifie le type de licence logicielle qui sera appliqué aux machines virtuelles déployées sur l’hôte dédié. Les valeurs possibles sont : None,Windows_Server_Hybrid,Windows_Server_Perpetual. La valeur par défaut est : None.

Nom	Type	Description
None	string
Windows_Server_Hybrid	string
Windows_Server_Perpetual	string

InnerError

Détails internes de l’erreur.

Nom	Type	Description
errordetail	string	Message d’erreur interne ou vidage d’exception.
exceptiontype	string	Type d'exception.

InstanceViewStatus

Vue d’instance status.

Nom	Type	Description
code	string	Code d'état.
displayStatus	string	Étiquette courte localisable pour le status.
level	StatusLevelTypes	Code de niveau.
message	string	Message de status détaillé, y compris pour les alertes et les messages d’erreur.
time	string	Heure du status.

InstanceViewTypes

Expression de développement à appliquer à l’opération. 'InstanceView' récupère la liste des vues instance de l’hôte dédié. 'UserData' n’est pas pris en charge pour l’hôte dédié.

Nom	Type	Description
instanceView	string
userData	string

Sku

Décrit une référence sku de groupe de machines virtuelles identiques. REMARQUE : Si la nouvelle référence SKU de machine virtuelle n’est pas prise en charge sur le matériel sur lequel se trouve actuellement le groupe identique, vous devez libérer les machines virtuelles dans le groupe identique avant de modifier le nom de la référence SKU.

Nom	Type	Description
capacity	integer	Spécifie le nombre de machines virtuelles dans le groupe identique.
name	string	Nom de la référence sku.
tier	string	Spécifie le niveau des machines virtuelles dans un groupe identique. Valeurs possibles : Standard De base

StatusLevelTypes

Code de niveau.

Nom	Type	Description
Error	string
Info	string
Warning	string

SubResourceReadOnly

Nom	Type	Description
id	string	ID de ressource

Dedicated Hosts - Get

Paramètres URI

Réponses

Sécurité

azure_auth

Scopes

Exemples

Get a dedicated host.

Sample Request

Sample Response

Définitions

ApiError

ApiErrorBase

CloudError

DedicatedHost

DedicatedHostAllocatableVM

DedicatedHostAvailableCapacity

DedicatedHostInstanceView

DedicatedHostLicenseTypes

InnerError

InstanceViewStatus

InstanceViewTypes

Sku

StatusLevelTypes

SubResourceReadOnly

Ressources supplémentaires