Virtual Machine Scale Set VMs - Get Instance View

Služba:: Compute

Verze rozhraní API:: 2025-11-01

Získá stav virtuálního počítače ze škálovací sady virtuálních počítačů.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
instanceId	path	True	string	ID instance virtuálního počítače.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
subscriptionId	path	True	string minLength: 1	ID cílového předplatného.
vmScaleSetName	path	True	string	Název škálovací sady virtuálních počítačů
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Odpovědi

Name	Typ	Description
200 OK	VirtualMachineScaleSetVMInstanceView	Operace Azure byla úspěšně dokončena.
Other Status Codes	CloudError	Neočekávaná chybová odpověď

Zabezpečení

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

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

Příklady

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

Ukázková odpověď

Stavový kód:: 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
    }
  ]
}

Definice

Name	Description
ApiError	Chyba rozhraní API.
ApiErrorBase	Chybová základna API.
BootDiagnosticsInstanceView	Zobrazení instance diagnostiky spouštění virtuálního počítače.
CloudError	Chybová odpověď ze služby Compute.
DiskEncryptionSettings	Popisuje nastavení šifrování pro disk
DiskInstanceView	Zobrazení instance disku.
HyperVGeneration	Generace hypervisoru virtuálního počítače [V1, V2]
InnerError	Podrobnosti vnitřní chyby.
InstanceViewStatus	Stav zobrazení instance
KeyVaultKeyReference	Popisuje odkaz na Key Vault Key
KeyVaultSecretReference	Popisuje odkaz na Key Vault Secret
MaintenanceOperationResultCodeTypes	Kód výsledku poslední operace údržby.
MaintenanceRedeployStatus	Stav provozu údržby.
StatusLevelTypes	Kód úrovně.
StorageAlignmentStatus	Specifikuje stav zarovnání úložiště pro disk.
SubResource
VirtualMachineAgentInstanceView	Zobrazení instance agenta virtuálního počítače spuštěného ve virtuálním počítači.
VirtualMachineExtensionHandlerInstanceView	Zobrazení instance obslužné rutiny rozšíření virtuálního počítače.
VirtualMachineExtensionInstanceView	Zobrazení instance rozšíření virtuálního počítače.
VirtualMachineHealthStatus	Stav virtuálního počítače.
VirtualMachineScaleSetVMInstanceView	Zobrazení instance virtuálního počítače škálovací sady virtuálních počítačů

ApiError

Objekt

Chyba rozhraní API.

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

ApiErrorBase

Objekt

Chybová základna API.

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

BootDiagnosticsInstanceView

Objekt

Zobrazení instance diagnostiky spouštění virtuálního počítače.

Name	Typ	Description
consoleScreenshotBlobUri	string	Identifikátor URI objektu blob snímku konzoly. Poznámka: Tato možnost nebude nastavena, pokud je diagnostika spouštění aktuálně povolena se spravovaným úložištěm.
serialConsoleLogBlobUri	string	Identifikátor URI objektu blob protokolu konzoly sériové části. Poznámka: Tato možnost nebude nastavena, pokud je diagnostika spouštění aktuálně povolena se spravovaným úložištěm.
status	InstanceViewStatus	Informace o stavu diagnostiky spouštění pro virtuální počítač. Poznámka: Bude nastavena pouze v případě, že dojde k chybám při povolování diagnostiky spouštění.

CloudError

Objekt

Chybová odpověď ze služby Compute.

Name	Typ	Description
error	ApiError	Chyba rozhraní API.

DiskEncryptionSettings

Objekt

Popisuje nastavení šifrování pro disk

Name	Typ	Description
diskEncryptionKey	KeyVaultSecretReference	Specifikuje umístění šifrovacího klíče disku, což je Key Vault Secret.
enabled	boolean	Určuje, jestli má být na virtuálním počítači povolené šifrování disku.
keyEncryptionKey	KeyVaultKeyReference	Specifikuje umístění klíče pro šifrování klíče v Key Vault.

DiskInstanceView

Objekt

Zobrazení instance disku.

Name	Typ	Description
encryptionSettings	DiskEncryptionSettings[]	Určuje nastavení šifrování disku s operačním systémem. Minimální verze api: 2015-06-15
name	string	Název disku.
statuses	InstanceViewStatus[]	Informace o stavu zdroje
storageAlignmentStatus	StorageAlignmentStatus	Specifikuje stav zarovnání úložiště pro disk.

HyperVGeneration

Výčet

Generace hypervisoru virtuálního počítače [V1, V2]

Hodnota	Description
V1
V2

InnerError

Objekt

Podrobnosti vnitřní chyby.

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

InstanceViewStatus

Objekt

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ě výstrah a chybových zpráv.
time	string (date-time)	Čas stavu.

KeyVaultKeyReference

Objekt

Popisuje odkaz na Key Vault Key

Name	Typ	Description
keyUrl	string	URL odkazující na klíč pro šifrování klíče v Key Vault.
sourceVault	SubResource	Relativní URL Key Vault, která obsahuje klíč.

KeyVaultSecretReference

Objekt

Popisuje odkaz na Key Vault Secret

Name	Typ	Description
secretUrl	string	URL odkazující na tajemství v Key Vault.
sourceVault	SubResource	Relativní URL Key Vault obsahující tajemství.

MaintenanceOperationResultCodeTypes

Výčet

Kód výsledku poslední operace údržby.

Hodnota	Description
None
RetryLater
MaintenanceAborted
MaintenanceCompleted

MaintenanceRedeployStatus

Objekt

Stav provozu údržby.

Name	Typ	Description
isCustomerInitiatedMaintenanceAllowed	boolean	True, pokud je zákazníkovi povoleno provádět údržbu.
lastOperationMessage	string	Zpráva vrácená pro poslední operaci údržby.
lastOperationResultCode	MaintenanceOperationResultCodeTypes	Kód výsledku poslední operace údržby.
maintenanceWindowEndTime	string (date-time)	Čas ukončení časového období údržby.
maintenanceWindowStartTime	string (date-time)	Čas spuštění časového období údržby.
preMaintenanceWindowEndTime	string (date-time)	Čas ukončení časového období předběžné údržby.
preMaintenanceWindowStartTime	string (date-time)	Čas spuštění časového období před údržbou.

StatusLevelTypes

Výčet

Kód úrovně.

Hodnota	Description
Info
Warning
Error

StorageAlignmentStatus

Výčet

Specifikuje stav zarovnání úložiště pro disk.

Hodnota	Description
Unaligned	Disk nemá mapování Storage Fault Domain to Compute Fault Domain. Jediné selhání domény Storage Fault může zasáhnout všechny VM, které odkazují na tento diskový profil.
Aligned	Disk má mapování Storage Fault Domain to Compute Fault Domain. Selhání domény poruch úložiště je omezeno na VM v jedné doméně výpočetní chyby.

SubResource

Objekt

Name	Typ	Description
id	string	ID prostředku

VirtualMachineAgentInstanceView

Objekt

Zobrazení instance agenta virtuálního počítače spuštěného ve virtuálním počítači.

Name	Typ	Description
extensionHandlers	VirtualMachineExtensionHandlerInstanceView[]	Zobrazení instance obslužné rutiny rozšíření virtuálního počítače.
statuses	InstanceViewStatus[]	Informace o stavu zdroje
vmAgentVersion	string	Plná verze nástroje VM Agent.

VirtualMachineExtensionHandlerInstanceView

Objekt

Zobrazení instance obslužné rutiny rozšíření virtuálního počítače.

Name	Typ	Description
status	InstanceViewStatus	Stav obslužné rutiny rozšíření.
type	string	Určuje typ rozšíření; Příkladem je CustomScriptExtension.
typeHandlerVersion	string	Určuje verzi obslužné rutiny skriptu.

VirtualMachineExtensionInstanceView

Objekt

Zobrazení instance rozšíření virtuálního počítače.

Name	Typ	Description
name	string	Název rozšíření virtuálního počítače.
statuses	InstanceViewStatus[]	Informace o stavu zdroje
substatuses	InstanceViewStatus[]	Informace o stavu zdroje
type	string	Určuje typ rozšíření; Příkladem je CustomScriptExtension.
typeHandlerVersion	string	Určuje verzi obslužné rutiny skriptu.

VirtualMachineHealthStatus

Objekt

Stav virtuálního počítače.

Name	Typ	Description
status	InstanceViewStatus	Informace o stavu virtuálního počítače.

VirtualMachineScaleSetVMInstanceView

Objekt

Zobrazení instance virtuálního počítače škálovací sady virtuálních počítačů

Name	Typ	Description
assignedHost	string	ID prostředku vyhrazeného hostitele, na kterém je virtuální počítač přidělen prostřednictvím automatického umístění, pokud je virtuální počítač přidružen k vyhrazené skupině hostitelů, která má automatické umístění povoleno. Minimální verze api: 2020-06-01.
bootDiagnostics	BootDiagnosticsInstanceView	Diagnostika spouštění je funkce ladění, která umožňuje zobrazit výstup konzoly a snímek obrazovky pro diagnostiku stavu virtuálního počítače. Výstup protokolu konzoly můžete snadno zobrazit. Azure také umožňuje vidět screenshot VM z hypervisoru.
computerName	string	Určuje název hostitelského operačního systému virtuálního počítače. Tento název nelze po vytvoření virtuálního počítače aktualizovat. Maximální délka (Windows): 15 znaků Maximální délka (Linux): 64 znaků. Pro konvence pojmenování a omezení viz Azure pokyny pro implementaci infrastrukturních služeb.
disks	DiskInstanceView[]	Informace o discích.
extensions	VirtualMachineExtensionInstanceView[]	Informace o rozšířeních.
hyperVGeneration	HyperVGeneration	Generace hypervisoru virtuálního počítače [V1, V2]
maintenanceRedeployStatus	MaintenanceRedeployStatus	Stav operace údržby na virtuálním počítači.
osName	string	Operační systém spuštěný na hybridním počítači.
osVersion	string	Verze operačního systému spuštěného na hybridním počítači.
placementGroupId	string	Skupina umístění, ve které je virtuální počítač spuštěný. Pokud je virtuální počítač uvolněný, nebude mít id placementGroupId.
platformFaultDomain	integer (int32)	Počet domén selhání.
platformUpdateDomain	integer (int32)	Počet aktualizačních domén.
rdpThumbPrint	string	Kryptografický otisk certifikátu vzdálené plochy.
statuses	InstanceViewStatus[]	Informace o stavu zdroje
vmAgent	VirtualMachineAgentInstanceView	Agent virtuálního počítače spuštěný ve virtuálním počítači.
vmHealth	VirtualMachineHealthStatus	Stav virtuálního počítače.