Virtual Machine Scale Set VMs - Get Instance View

Service:: Compute

Version d'API:: 2025-11-01

Obtient l’état d’une machine virtuelle à partir d’un groupe de machines virtuelles identiques.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/instanceView?api-version=2025-11-01

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
instanceId	path	True	string	ID d’instance de la machine virtuelle.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nom du groupe de ressources. Le nom ne respecte pas la casse.
subscriptionId	path	True	string minLength: 1	ID de l’abonnement cible.
vmScaleSetName	path	True	string	Nom du groupe de machines virtuelles identiques.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

Réponses

Nom	Type	Description
200 OK	VirtualMachineScaleSetVMInstanceView	Opération Azure terminée avec succès.
Other Status Codes	CloudError	Réponse d’erreur inattendue.

Sécurité

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

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

Exemples

Get instance view of a virtual machine from a VM scale set placed on a dedicated host group through automatic placement.

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myVirtualMachineScaleSet/virtualMachines/0/instanceView?api-version=2025-11-01

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Compute.Models;
using Azure.ResourceManager.Resources.Models;
using Azure.ResourceManager.Compute;

// Generated from example definition: specification/compute/resource-manager/Microsoft.Compute/Compute/stable/2025-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Get_InstanceViewAutoPlacedOnDedicatedHostGroup.json
// this example is just showing the usage of "VirtualMachineScaleSetVMs_GetInstanceView" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this VirtualMachineScaleSetVmResource created on azure
// for more information of creating VirtualMachineScaleSetVmResource, please refer to the document of VirtualMachineScaleSetVmResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "myResourceGroup";
string virtualMachineScaleSetName = "myVirtualMachineScaleSet";
string instanceId = "0";
ResourceIdentifier virtualMachineScaleSetVmResourceId = VirtualMachineScaleSetVmResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, virtualMachineScaleSetName, instanceId);
VirtualMachineScaleSetVmResource virtualMachineScaleSetVm = client.GetVirtualMachineScaleSetVmResource(virtualMachineScaleSetVmResourceId);

// invoke the operation
VirtualMachineScaleSetVmInstanceView result = await virtualMachineScaleSetVm.GetInstanceViewAsync();

Console.WriteLine($"Succeeded: {result}");

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

Exemple de réponse

Code d’état:: 200

{
  "platformUpdateDomain": 0,
  "platformFaultDomain": 0,
  "rdpThumbPrint": null,
  "vmAgent": {
    "vmAgentVersion": "Unknown",
    "statuses": [
      {
        "code": "ProvisioningState/Unavailable",
        "level": "Warning",
        "displayStatus": "Not Ready",
        "message": "VM status blob is found but not yet populated.",
        "time": "2025-04-01T05:00:32+00:00"
      }
    ],
    "extensionHandlers": null
  },
  "disks": [
    {
      "name": "myOSDisk",
      "encryptionSettings": null,
      "statuses": [
        {
          "code": "ProvisioningState/succeeded",
          "level": "Info",
          "displayStatus": "Provisioning succeeded",
          "message": null,
          "time": "2025-04-01T04:58:58.0882815+00:00"
        }
      ]
    }
  ],
  "extensions": null,
  "assignedHost": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/hostGroups/myHostGroup/hosts/myHost",
  "bootDiagnostics": null,
  "statuses": [
    {
      "code": "ProvisioningState/succeeded",
      "level": "Info",
      "displayStatus": "Provisioning succeeded",
      "message": null,
      "time": "2020-06-05T04:59:58.1852966+00:00"
    },
    {
      "code": "PowerState/running",
      "level": "Info",
      "displayStatus": "VM running",
      "message": null,
      "time": null
    }
  ]
}

Définitions

Nom	Description
ApiError	Erreur d’API.
ApiErrorBase	Base d’erreur de l’API.
BootDiagnosticsInstanceView	Vue d’instance des diagnostics de démarrage d’une machine virtuelle.
CloudError	Réponse d’erreur du service de calcul.
DiskEncryptionSettings	Décrit les paramètres de chiffrement d’un disque
DiskInstanceView	Vue d’instance du disque.
HyperVGeneration	Génération d’hyperviseur de la machine virtuelle [V1, V2]
InnerError	Détails de l’erreur interne.
InstanceViewStatus	État de l’affichage de l’instance.
KeyVaultKeyReference	Décrit une référence à Key Vault Key
KeyVaultSecretReference	Décrit une référence à Key Vault Secret
MaintenanceOperationResultCodeTypes	Code de résultat de la dernière opération de maintenance.
MaintenanceRedeployStatus	État de fonctionnement de maintenance.
StatusLevelTypes	Code de niveau.
StorageAlignmentStatus	Spécifie l’état d’alignement de stockage pour le disque.
SubResource
VirtualMachineAgentInstanceView	Vue d’instance de l’agent de machine virtuelle en cours d’exécution sur la machine virtuelle.
VirtualMachineExtensionHandlerInstanceView	Vue d’instance d’un gestionnaire d’extensions de machine virtuelle.
VirtualMachineExtensionInstanceView	Vue d’instance d’une extension de machine virtuelle.
VirtualMachineHealthStatus	L’état d’intégrité de la machine virtuelle.
VirtualMachineScaleSetVMInstanceView	Vue d’instance d’une machine virtuelle de groupe de machines virtuelles identiques.

ApiError

Objet

Erreur d’API.

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

ApiErrorBase

Objet

Base d’erreur de l’API.

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

BootDiagnosticsInstanceView

Objet

Vue d’instance des diagnostics de démarrage d’une machine virtuelle.

Nom	Type	Description
consoleScreenshotBlobUri	string	URI de l’objet blob de capture d’écran de la console. Note: Ce paramètre n’est pas défini si les diagnostics de démarrage sont actuellement activés avec le stockage géré.
serialConsoleLogBlobUri	string	Uri de l’objet blob de journaux de la console série. Note: Ce paramètre n’est pas défini si les diagnostics de démarrage sont actuellement activés avec le stockage géré.
status	InstanceViewStatus	Informations sur l’état des diagnostics de démarrage de la machine virtuelle. Note: Il ne sera défini que si des erreurs sont rencontrées lors de l’activation des diagnostics de démarrage.

CloudError

Objet

Réponse d’erreur du service de calcul.

Nom	Type	Description
error	ApiError	Erreur d’API.

DiskEncryptionSettings

Objet

Décrit les paramètres de chiffrement d’un disque

Nom	Type	Description
diskEncryptionKey	KeyVaultSecretReference	Spécifie l’emplacement de la clé de chiffrement du disque, qui est un Key Vault Secret.
enabled	boolean	Spécifie si le chiffrement de disque doit être activé sur la machine virtuelle.
keyEncryptionKey	KeyVaultKeyReference	Précise l’emplacement de la clé de chiffrement de la clé dans Key Vault.

DiskInstanceView

Objet

Vue d’instance du disque.

Nom	Type	Description
encryptionSettings	DiskEncryptionSettings[]	Spécifie les paramètres de chiffrement du disque du système d’exploitation. Version minimale de l’API : 2015-06-15
name	string	Nom du disque.
statuses	InstanceViewStatus[]	Informations d’état de la ressource.
storageAlignmentStatus	StorageAlignmentStatus	Spécifie l’état d’alignement de stockage pour le disque.

HyperVGeneration

Énumération

Génération d’hyperviseur de la machine virtuelle [V1, V2]

Valeur	Description
V1
V2

InnerError

Objet

Détails de l’erreur interne.

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

InstanceViewStatus

Objet

État de l’affichage de l’instance.

Nom	Type	Description
code	string	Code d’état.
displayStatus	string	Étiquette localisable courte pour l’état.
level	StatusLevelTypes	Code de niveau.
message	string	Message d’état détaillé, y compris pour les alertes et les messages d’erreur.
time	string (date-time)	Heure de l’état.

KeyVaultKeyReference

Objet

Décrit une référence à Key Vault Key

Nom	Type	Description
keyUrl	string	L’URL faisant référence à une clé de chiffrement de clé dans Key Vault.
sourceVault	SubResource	L’URL relative du Key Vault contenant la clé.

KeyVaultSecretReference

Objet

Décrit une référence à Key Vault Secret

Nom	Type	Description
secretUrl	string	L’URL faisant référence à un secret dans un Key Vault.
sourceVault	SubResource	L’URL relative du Key Vault contenant le secret.

MaintenanceOperationResultCodeTypes

Énumération

Code de résultat de la dernière opération de maintenance.

Valeur	Description
None
RetryLater
MaintenanceAborted
MaintenanceCompleted

MaintenanceRedeployStatus

Objet

État de fonctionnement de maintenance.

Nom	Type	Description
isCustomerInitiatedMaintenanceAllowed	boolean	Vrai, si le client est autorisé à effectuer la maintenance.
lastOperationMessage	string	Message renvoyé pour la dernière opération de maintenance.
lastOperationResultCode	MaintenanceOperationResultCodeTypes	Code de résultat de la dernière opération de maintenance.
maintenanceWindowEndTime	string (date-time)	Heure de fin de la fenêtre de maintenance.
maintenanceWindowStartTime	string (date-time)	Heure de début de la fenêtre de maintenance.
preMaintenanceWindowEndTime	string (date-time)	Heure de fin de la fenêtre de pré-maintenance.
preMaintenanceWindowStartTime	string (date-time)	Heure de début de la fenêtre de pré-maintenance.

StatusLevelTypes

Énumération

Code de niveau.

Valeur	Description
Info
Warning
Error

StorageAlignmentStatus

Énumération

Spécifie l’état d’alignement de stockage pour le disque.

Valeur	Description
Unaligned	Le disque ne possède pas de domaine de défaut de stockage pour calculer la correspondance du domaine de défaut. Une seule défaillance du domaine de défaut de stockage peut affecter toutes les machines virtuelles qui font référence à ce profil disque.
Aligned	Le disque dispose d’un domaine de défaut de stockage pour calculer la correspondance du domaine de défaut. La défaillance du domaine de défaut de stockage est contenue dans les VM dans un seul domaine de défaut de calcul.

SubResource

Objet

Nom	Type	Description
id	string	ID de ressource

VirtualMachineAgentInstanceView

Objet

Vue d’instance de l’agent de machine virtuelle en cours d’exécution sur la machine virtuelle.

Nom	Type	Description
extensionHandlers	VirtualMachineExtensionHandlerInstanceView[]	Vue d’instance du gestionnaire d’extension de machine virtuelle.
statuses	InstanceViewStatus[]	Informations d’état de la ressource.
vmAgentVersion	string	La version complète de VM Agent.

VirtualMachineExtensionHandlerInstanceView

Objet

Vue d’instance d’un gestionnaire d’extensions de machine virtuelle.

Nom	Type	Description
status	InstanceViewStatus	État du gestionnaire d’extensions.
type	string	Spécifie le type de l’extension ; un exemple est « CustomScriptExtension ».
typeHandlerVersion	string	Spécifie la version du gestionnaire de scripts.

VirtualMachineExtensionInstanceView

Objet

Vue d’instance d’une extension de machine virtuelle.

Nom	Type	Description
name	string	Nom de l’extension de machine virtuelle.
statuses	InstanceViewStatus[]	Informations d’état de la ressource.
substatuses	InstanceViewStatus[]	Informations d’état de la ressource.
type	string	Spécifie le type de l’extension ; un exemple est « CustomScriptExtension ».
typeHandlerVersion	string	Spécifie la version du gestionnaire de scripts.

VirtualMachineHealthStatus

Objet

L’état d’intégrité de la machine virtuelle.

Nom	Type	Description
status	InstanceViewStatus	Informations sur l’état d’intégrité de la machine virtuelle.

VirtualMachineScaleSetVMInstanceView

Objet

Vue d’instance d’une machine virtuelle de groupe de machines virtuelles identiques.

Nom	Type	Description
assignedHost	string	ID de ressource de l’hôte dédié, sur lequel la machine virtuelle est allouée par le biais du placement automatique, lorsque la machine virtuelle est associée à un groupe d’hôtes dédié pour lequel le placement automatique est activé. Version minimale de l’API : 2020-06-01.
bootDiagnostics	BootDiagnosticsInstanceView	Diagnostics de démarrage est une fonctionnalité de débogage qui vous permet d’afficher la sortie de la console et la capture d’écran pour diagnostiquer l’état de la machine virtuelle. Vous pouvez facilement afficher la sortie de votre journal de console. Azure permet aussi de voir une capture d’écran de la VM depuis l’hyperviseur.
computerName	string	Spécifie le nom du système d’exploitation hôte de la machine virtuelle. Ce nom ne peut pas être mis à jour une fois la machine virtuelle créée. Longueur maximale (Windows) : 15 caractères longueur maximale (Linux) : 64 caractères. Pour les conventions de nommage et les restrictions, voir Azure directives de mise en œuvre des services d’infrastructure.
disks	DiskInstanceView[]	Informations sur les disques.
extensions	VirtualMachineExtensionInstanceView[]	Les informations sur les extensions.
hyperVGeneration	HyperVGeneration	Génération d’hyperviseur de la machine virtuelle [V1, V2]
maintenanceRedeployStatus	MaintenanceRedeployStatus	L’état de l’opération de maintenance sur la machine virtuelle.
osName	string	Système d’exploitation s’exécutant sur la machine hybride.
osVersion	string	Version du système d’exploitation s’exécutant sur la machine hybride.
placementGroupId	string	Groupe de placement dans lequel la machine virtuelle est en cours d’exécution. Si la machine virtuelle est libérée, elle n’a pas de placementGroupId.
platformFaultDomain	integer (int32)	Nombre de domaines d’erreur.
platformUpdateDomain	integer (int32)	Nombre de domaines de mise à jour.
rdpThumbPrint	string	Empreinte numérique du certificat Bureau à distance.
statuses	InstanceViewStatus[]	Informations d’état de la ressource.
vmAgent	VirtualMachineAgentInstanceView	L’agent VM s’exécutant sur la machine virtuelle.
vmHealth	VirtualMachineHealthStatus	L’état d’intégrité de la machine virtuelle.