Virtual Machines - Instance View

Služba:: Compute

Verze rozhraní API:: 2025-04-01

Načte informace o stavu virtuálního počítače za běhu.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
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.
vmName	path	True	string	Název virtuálního počítače.
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	VirtualMachineInstanceView	Operace Azure byla úspěšně dokončena.
Other Status Codes	CloudError	Neočekávaná chybová odpověď

Zabezpečení

azure_auth

Tok OAuth2 v Azure Active Directory

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 placed on a dedicated host group through automatic placement.

Get Virtual Machine Instance View.

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

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:: 200

{
  "computerName": "myVM",
  "osName": "Windows Server 2016 Datacenter",
  "osVersion": "Microsoft Windows NT 10.0.14393.0",
  "vmAgent": {
    "vmAgentVersion": "2.7.41491.949",
    "statuses": [
      {
        "code": "ProvisioningState/succeeded",
        "level": "Info",
        "displayStatus": "Ready",
        "message": "GuestAgent is running and accepting new configurations.",
        "time": "2025-04-01T23:11:22+00:00"
      }
    ]
  },
  "disks": [
    {
      "name": "myOsDisk",
      "statuses": [
        {
          "code": "ProvisioningState/succeeded",
          "level": "Info",
          "displayStatus": "Provisioning succeeded",
          "time": "2025-04-01T21:29:47.477089+00:00"
        }
      ]
    }
  ],
  "hyperVGeneration": "V1",
  "assignedHost": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/hostGroups/myHostGroup/hosts/myHost",
  "statuses": [
    {
      "code": "ProvisioningState/succeeded",
      "level": "Info",
      "displayStatus": "Provisioning succeeded",
      "time": "2025-04-01T21:30:12.8051917+00:00"
    },
    {
      "code": "PowerState/running",
      "level": "Info",
      "displayStatus": "VM running"
    }
  ]
}

Get Virtual Machine Instance View.

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:: 200

{
  "platformUpdateDomain": 1,
  "platformFaultDomain": 1,
  "computerName": "myVM",
  "osName": "Windows Server 2016 Datacenter",
  "osVersion": "Microsoft Windows NT 10.0.14393.0",
  "vmAgent": {
    "vmAgentVersion": "2.7.41491.949",
    "statuses": [
      {
        "code": "ProvisioningState/succeeded",
        "level": "Info",
        "displayStatus": "Ready",
        "message": "GuestAgent is running and accepting new configurations.",
        "time": "2019-10-14T23:11:22+00:00"
      }
    ],
    "extensionHandlers": [
      {
        "type": "Microsoft.Azure.Security.IaaSAntimalware",
        "typeHandlerVersion": "1.5.5.9",
        "status": {
          "code": "ProvisioningState/succeeded",
          "level": "Info",
          "displayStatus": "Ready"
        }
      }
    ]
  },
  "disks": [
    {
      "name": "myOsDisk",
      "statuses": [
        {
          "code": "ProvisioningState/succeeded",
          "level": "Info",
          "displayStatus": "Provisioning succeeded",
          "time": "2019-10-14T21:29:47.477089+00:00"
        }
      ]
    },
    {
      "name": "myDataDisk0",
      "statuses": [
        {
          "code": "ProvisioningState/succeeded",
          "level": "Info",
          "displayStatus": "Provisioning succeeded",
          "time": "2019-10-14T21:29:47.461517+00:00"
        }
      ]
    }
  ],
  "bootDiagnostics": {
    "consoleScreenshotBlobUri": "https://{myStorageAccount}.blob.core.windows.net/bootdiagnostics-myOsDisk/myOsDisk.screenshot.bmp",
    "serialConsoleLogBlobUri": "https://{myStorageAccount}.blob.core.windows.net/bootdiagnostics-myOsDisk/myOsDisk.serialconsole.log"
  },
  "extensions": [
    {
      "name": "IaaSAntiMalware-ext0",
      "type": "Microsoft.Azure.Security.IaaSAntimalware",
      "typeHandlerVersion": "1.5.5.9",
      "statuses": [
        {
          "code": "ProvisioningState/succeeded",
          "level": "Info",
          "displayStatus": "Provisioning succeeded",
          "message": "Microsoft Antimalware enabled"
        }
      ]
    }
  ],
  "hyperVGeneration": "V1",
  "patchStatus": {
    "availablePatchSummary": {
      "status": "Succeeded",
      "assessmentActivityId": "68f8b292-dfc2-4646-9781-33cc88631968",
      "rebootPending": true,
      "criticalAndSecurityPatchCount": 1,
      "otherPatchCount": 2,
      "startTime": "2020-04-24T21:02:04.2556154Z",
      "lastModifiedTime": "2020-04-24T21:02:04.2556154Z",
      "error": null
    },
    "lastPatchInstallationSummary": {
      "status": "Succeeded",
      "installationActivityId": "68f8b292-dfc2-4646-9981-33cc88631968",
      "maintenanceWindowExceeded": false,
      "notSelectedPatchCount": 1,
      "excludedPatchCount": 1,
      "pendingPatchCount": 1,
      "installedPatchCount": 1,
      "failedPatchCount": 1,
      "startTime": "2020-04-24T21:02:04.2556154Z",
      "lastModifiedTime": "2020-04-24T21:02:04.2556154Z",
      "error": null
    },
    "configurationStatuses": [
      {
        "code": "PatchModeConfigurationState/Ready",
        "level": "Info",
        "displayStatus": "Status_PatchModeConfigurationState_Ready",
        "time": "2020-04-24T21:02:04.2556154Z"
      },
      {
        "code": "AssessmentModeConfigurationState/Pending",
        "level": "Info",
        "displayStatus": "Status_AssessmentModeConfigurationState_Pending",
        "time": "2020-04-24T21:02:04.2556154Z"
      }
    ]
  },
  "isVMInStandbyPool": false,
  "statuses": [
    {
      "code": "ProvisioningState/succeeded",
      "level": "Info",
      "displayStatus": "Provisioning succeeded",
      "time": "2019-10-14T21:30:12.8051917+00:00"
    },
    {
      "code": "PowerState/running",
      "level": "Info",
      "displayStatus": "VM running"
    }
  ]
}

Definice

Name	Description
ApiError	Chyba rozhraní API.
ApiErrorBase	Chybová základna API.
AvailablePatchSummary	Popisuje vlastnosti zobrazení instance virtuálního počítače pro dostupný souhrn oprav.
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.
HyperVGenerationType	Určuje typ HyperVGeneration přidružený k prostředku
InnerError	Podrobnosti vnitřní chyby.
InstanceViewStatus	Stav zobrazení instance
KeyVaultKeyReference	Popisuje odkaz na klíč Key Vault
KeyVaultSecretReference	Popisuje odkaz na tajný klíč služby Key Vault.
LastPatchInstallationSummary	Popisuje vlastnosti souhrnu poslední nainstalované opravy.
MaintenanceOperationResultCodeTypes	Kód výsledku poslední operace údržby.
MaintenanceRedeployStatus	Stav provozu údržby.
PatchOperationStatus	Celkový stav úspěchu nebo neúspěchu operace. Zůstane "InProgress", dokud se operace nedokončí. V tomto okamžiku se změní na "Neznámé", "Nezdařilo se", "Úspěšné" nebo "DokončenoWithWarnings".
StatusLevelTypes	Kód úrovně.
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.
VirtualMachineInstanceView	Zobrazení instance virtuálního počítače.
VirtualMachinePatchStatus	Stav operací oprav 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.

AvailablePatchSummary

Objekt

Popisuje vlastnosti zobrazení instance virtuálního počítače pro dostupný souhrn oprav.

Name	Typ	Description
assessmentActivityId	string	ID aktivity operace, která vytvořila tento výsledek. Používá se ke korelaci mezi protokoly CRP a rozšířeními.
criticalAndSecurityPatchCount	integer (int32)	Počet kritických nebo bezpečnostních záplat, které byly zjištěny jako dostupné a dosud nebyly nainstalovány.
error	ApiError	Chyby, ke kterým došlo během provádění operace. Pole podrobností obsahuje jejich seznam.
lastModifiedTime	string (date-time)	Časové razítko UTC, kdy operace začala.
otherPatchCount	integer (int32)	Počet všech dostupných záplat kromě kritických a bezpečnostních.
rebootPending	boolean	Celkový stav restartování virtuálního počítače. Bude to platit, když částečně nainstalované opravy vyžadují k dokončení instalace restart, ale k restartu ještě nedošlo.
startTime	string (date-time)	Časové razítko UTC, kdy operace začala.
status	PatchOperationStatus	Celkový stav úspěchu nebo neúspěchu operace. Zůstane "InProgress", dokud se operace nedokončí. V tomto okamžiku se změní na "Neznámé", "Nezdařilo se", "Úspěšné" nebo "DokončenoWithWarnings".

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	Určuje umístění šifrovacího klíče disku, což je tajný klíč služby Key Vault.
enabled	boolean	Určuje, jestli má být na virtuálním počítači povolené šifrování disku.
keyEncryptionKey	KeyVaultKeyReference	Určuje umístění šifrovacího klíče klíče ve službě 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

HyperVGenerationType

Výčet

Určuje typ HyperVGeneration přidružený k prostředku

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 klíč Key Vault

Name	Typ	Description
keyUrl	string	Adresa URL odkazující na šifrovací klíč klíče ve službě Key Vault.
sourceVault	SubResource	Relativní adresa URL služby Key Vault obsahující klíč.

KeyVaultSecretReference

Objekt

Popisuje odkaz na tajný klíč služby Key Vault.

Name	Typ	Description
secretUrl	string	Adresa URL odkazující na tajný kód ve službě Key Vault.
sourceVault	SubResource	Relativní adresa URL služby Key Vault obsahující tajný klíč.

LastPatchInstallationSummary

Objekt

Popisuje vlastnosti souhrnu poslední nainstalované opravy.

Name	Typ	Description
error	ApiError	Chyby, ke kterým došlo během provádění operace. Pole podrobností obsahuje jejich seznam.
excludedPatchCount	integer (int32)	Počet všech dostupných oprav, které jsou však explicitně vyloučeny seznamem vyloučení zadaným zákazníkem, se shoduje.
failedPatchCount	integer (int32)	Počet oprav, u kterých se instalace nezdařila.
installationActivityId	string	ID aktivity operace, která vytvořila tento výsledek. Používá se ke korelaci mezi protokoly CRP a rozšířeními.
installedPatchCount	integer (int32)	Počet oprav, které byly úspěšně nainstalovány.
lastModifiedTime	string (date-time)	Časové razítko UTC, kdy operace začala.
maintenanceWindowExceeded	boolean	Popisuje, zda operaci vypršel čas před dokončením všech zamýšlených akcí
notSelectedPatchCount	integer (int32)	Počet všech dostupných oprav, které však nebudou nainstalovány, protože neodpovídaly položce klasifikace nebo seznamu zahrnutí.
pendingPatchCount	integer (int32)	Počet všech dostupných oprav, které mají být nainstalovány v průběhu instalace opravy.
startTime	string (date-time)	Časové razítko UTC, kdy operace začala.
status	PatchOperationStatus	Celkový stav úspěchu nebo neúspěchu operace. Zůstane "InProgress", dokud se operace nedokončí. V tomto okamžiku se změní na "Neznámé", "Nezdařilo se", "Úspěšné" nebo "DokončenoWithWarnings".

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.

PatchOperationStatus

Výčet

Celkový stav úspěchu nebo neúspěchu operace. Zůstane "InProgress", dokud se operace nedokončí. V tomto okamžiku se změní na "Neznámé", "Nezdařilo se", "Úspěšné" nebo "DokončenoWithWarnings".

Hodnota	Description
Unknown
InProgress
Failed
Succeeded
CompletedWithWarnings

StatusLevelTypes

Výčet

Kód úrovně.

Hodnota	Description
Info
Warning
Error

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.

VirtualMachineInstanceView

Objekt

Zobrazení instance virtuálního počítače.

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 zobrazit snímek obrazovky virtuálního počítače z hypervisoru.
computerName	string	Název počítače přiřazený virtuálnímu počítači.
disks	DiskInstanceView[]	Informace o disku virtuálního počítače.
extensions	VirtualMachineExtensionInstanceView[]	Informace o rozšířeních.
hyperVGeneration	HyperVGenerationType	Určuje typ HyperVGeneration přidružený k prostředku
isVMInStandbyPool	boolean	[Funkce náhledu] Určuje, zda je virtuální počítač aktuálně v pohotovostním fondu nebo mimo něj.
maintenanceRedeployStatus	MaintenanceRedeployStatus	Stav operace údržby na virtuálním počítači.
osName	string	Operační systém spuštěný ve virtuálním počítači.
osVersion	string	Verze operačního systému spuštěná ve virtuálním počítači.
patchStatus	VirtualMachinePatchStatus	[Funkce náhledu] Stav operací oprav virtuálních počítačů.
platformFaultDomain	integer (int32)	Určuje doménu selhání virtuálního počítače.
platformUpdateDomain	integer (int32)	Určuje aktualizační doménu virtuálního počítače.
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.

VirtualMachinePatchStatus

Objekt

Stav operací oprav virtuálních počítačů.

Name	Typ	Description
availablePatchSummary	AvailablePatchSummary	Dostupný souhrn oprav nejnovější operace posouzení pro virtuální počítač.
configurationStatuses	InstanceViewStatus[]	Stav povolení zadaného režimu patchMode
lastPatchInstallationSummary	LastPatchInstallationSummary	Souhrn instalace poslední instalační operace pro virtuální počítač.

Sdílet prostřednictvím

Virtual Machines - Instance View

Parametry identifikátoru URI

Odpovědi

Zabezpečení

azure_auth

Rozsahy

Příklady

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

Ukázkový požadavek

Ukázková odpověď

Get Virtual Machine Instance View.

Ukázkový požadavek

Ukázková odpověď

Definice

ApiError

ApiErrorBase

AvailablePatchSummary

BootDiagnosticsInstanceView

CloudError

DiskEncryptionSettings

DiskInstanceView

HyperVGenerationType

InnerError

InstanceViewStatus

KeyVaultKeyReference

KeyVaultSecretReference

LastPatchInstallationSummary

MaintenanceOperationResultCodeTypes

MaintenanceRedeployStatus

PatchOperationStatus

StatusLevelTypes

SubResource

VirtualMachineAgentInstanceView

VirtualMachineExtensionHandlerInstanceView

VirtualMachineExtensionInstanceView

VirtualMachineHealthStatus

VirtualMachineInstanceView

VirtualMachinePatchStatus