Virtual Machines - Instance View

Lekéri a virtuális gép futásidejű állapotával kapcsolatos információkat.

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

URI-paraméterek

Name In Kötelező Típus Description
resourceGroupName
path True

string

Az erőforráscsoport neve.

subscriptionId
path True

string

Az előfizetés hitelesítő adatai, amelyek egyedileg azonosítják a Microsoft Azure-előfizetést. Az előfizetés-azonosító az URI részét képezi minden szolgáltatáshíváshoz.

vmName
path True

string

A virtuális gép neve.

api-version
query True

string

Client API-verzió.

Válaszok

Name Típus Description
200 OK

VirtualMachineInstanceView

OK

Other Status Codes

CloudError

Hibaválasz, amely leírja, hogy a művelet miért hiúsult meg.

Biztonság

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 felhasználói fiók megszemélyesítése

Példák

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.

Sample Request

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

Sample Response

{
  "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": "2024-03-01T23:11:22+00:00"
      }
    ]
  },
  "disks": [
    {
      "name": "myOsDisk",
      "statuses": [
        {
          "code": "ProvisioningState/succeeded",
          "level": "Info",
          "displayStatus": "Provisioning succeeded",
          "time": "2024-03-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": "2024-03-01T21:30:12.8051917+00:00"
    },
    {
      "code": "PowerState/running",
      "level": "Info",
      "displayStatus": "VM running"
    }
  ]
}

Get Virtual Machine Instance View.

Sample Request

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

Sample Response

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

Definíciók

Name Description
ApiError

API-hiba.

ApiErrorBase

API-hibabázis.

AvailablePatchSummary

A virtuális gép legújabb értékelési műveletének elérhető javítási összefoglalása.

BootDiagnosticsInstanceView

A rendszerindítási diagnosztika egy hibakeresési funkció, amellyel megtekintheti a konzol kimenetét és képernyőképét a virtuális gép állapotának diagnosztizálásához. A konzolnapló kimenetét egyszerűen megtekintheti. Az Azure lehetővé teszi a virtuális gép képernyőképének megtekintését is a hipervizorból.

CloudError

Hibaválasz a Compute szolgáltatástól.

DiskEncryptionSettings

Megadja az operációsrendszer-lemez titkosítási beállításait.

Minimális API-verzió: 2015-06-15

DiskInstanceView

A virtuális gép lemezadatai.

HyperVGenerationType

Megadja az erőforráshoz társított HyperVGeneration-típust

InnerError

Belső hiba részletei.

InstanceViewStatus

Példánynézet állapota.

KeyVaultKeyReference

Megadja a kulcstitkosítási kulcs helyét Key Vault.

KeyVaultSecretReference

Megadja a lemeztitkosítási kulcs helyét, amely egy Key Vault titkos kód.

LastPatchInstallationSummary

A virtuális gép legújabb telepítési műveletének telepítési összefoglalása.

MaintenanceOperationResultCodeTypes

Az utolsó karbantartási művelet eredménykódja.

MaintenanceRedeployStatus

A karbantartási művelet állapota a virtuális gépen.

PatchOperationStatus

A művelet általános sikeres vagy sikertelen állapota. A művelet befejezéséig "InProgress" marad. Ekkor "Ismeretlen", "Sikertelen", "Sikeres" vagy "CompletedWithWarnings" lesz.

StatusLevelTypes

A szintkód.

SubResource

A titkos kódot tartalmazó Key Vault relatív URL-címe.

VirtualMachineAgentInstanceView

A virtuális gépen futó virtuálisgép-ügynök.

VirtualMachineExtensionHandlerInstanceView

A virtuálisgép-bővítménykezelő példánynézete.

VirtualMachineExtensionInstanceView

A bővítmények adatai.

VirtualMachineHealthStatus

A virtuális gép állapota.

VirtualMachineInstanceView

Egy virtuális gép példánynézete.

VirtualMachinePatchStatus

[Előzetes verziójú funkció] A virtuális gépek javítási műveleteinek állapota.

ApiError

API-hiba.

Name Típus Description
code

string

A hibakód.

details

ApiErrorBase[]

Az API-hiba részletei

innererror

InnerError

Az API belső hibája

message

string

A hibaüzenet.

target

string

Az adott hiba célja.

ApiErrorBase

API-hibabázis.

Name Típus Description
code

string

A hibakód.

message

string

A hibaüzenet.

target

string

Az adott hiba célja.

AvailablePatchSummary

A virtuális gép legújabb értékelési műveletének elérhető javítási összefoglalása.

Name Típus Description
assessmentActivityId

string

Az eredményt eredményező művelet tevékenységazonosítója. A CRP- és a bővítménynaplók közötti korrelációra szolgál.

criticalAndSecurityPatchCount

integer

Azoknak a kritikus vagy biztonsági javításoknak a száma, amelyeket a rendszer elérhetőként észlelt, de még nem telepített.

error

ApiError

A művelet végrehajtása során észlelt hibák. A részletek tömb tartalmazza a lista őket.

lastModifiedTime

string

A művelet kezdetének UTC időbélyege.

otherPatchCount

integer

Az összes elérhető javítás száma a kritikus és a biztonság kivételével.

rebootPending

boolean

A virtuális gép általános újraindítási állapota. Ez akkor lesz igaz, ha a részben telepített javítások újraindítást igényelnek a telepítés befejezéséhez, de az újraindítás még nem történt meg.

startTime

string

A művelet kezdetének UTC időbélyege.

status

PatchOperationStatus

A művelet általános sikeres vagy sikertelen állapota. A művelet befejezéséig "InProgress" marad. Ekkor "Ismeretlen", "Sikertelen", "Sikeres" vagy "CompletedWithWarnings" lesz.

BootDiagnosticsInstanceView

A rendszerindítási diagnosztika egy hibakeresési funkció, amellyel megtekintheti a konzol kimenetét és képernyőképét a virtuális gép állapotának diagnosztizálásához. A konzolnapló kimenetét egyszerűen megtekintheti. Az Azure lehetővé teszi a virtuális gép képernyőképének megtekintését is a hipervizorból.

Name Típus Description
consoleScreenshotBlobUri

string

A konzol képernyőképének blob URI-ja. Megjegyzés: Ez nem lesz beállítva, ha a rendszerindítási diagnosztika jelenleg engedélyezve van a felügyelt tárterületen.

serialConsoleLogBlobUri

string

A soros konzol naplóblob URI-ja. Megjegyzés: Ez nem lesz beállítva, ha a rendszerindítási diagnosztika jelenleg engedélyezve van a felügyelt tárterületen.

status

InstanceViewStatus

A virtuális gép rendszerindítási diagnosztikai állapotadatai. Megjegyzés: Csak akkor lesz beállítva, ha a rendszerindítási diagnosztikák engedélyezése során hibák léptek fel.

CloudError

Hibaválasz a Compute szolgáltatástól.

Name Típus Description
error

ApiError

API-hiba.

DiskEncryptionSettings

Megadja az operációsrendszer-lemez titkosítási beállításait.

Minimális API-verzió: 2015-06-15

Name Típus Description
diskEncryptionKey

KeyVaultSecretReference

Megadja a lemeztitkosítási kulcs helyét, amely egy Key Vault titkos kód.

enabled

boolean

Megadja, hogy engedélyezni kell-e a lemeztitkosítást a virtuális gépen.

keyEncryptionKey

KeyVaultKeyReference

Megadja a kulcstitkosítási kulcs helyét Key Vault.

DiskInstanceView

A virtuális gép lemezadatai.

Name Típus Description
encryptionSettings

DiskEncryptionSettings[]

Megadja az operációsrendszer-lemez titkosítási beállításait.

Minimális API-verzió: 2015-06-15

name

string

A lemez neve.

statuses

InstanceViewStatus[]

Az erőforrás állapotadatai.

HyperVGenerationType

Megadja az erőforráshoz társított HyperVGeneration-típust

Name Típus Description
V1

string

V2

string

InnerError

Belső hiba részletei.

Name Típus Description
errordetail

string

A belső hibaüzenet vagy kivételkép.

exceptiontype

string

A kivétel típusa.

InstanceViewStatus

Példánynézet állapota.

Name Típus Description
code

string

Az állapotkód.

displayStatus

string

Az állapot rövid honosítható címkéje.

level

StatusLevelTypes

A szintkód.

message

string

A részletes állapotüzenet, beleértve a riasztásokat és a hibaüzeneteket is.

time

string

Az állapot időpontja.

KeyVaultKeyReference

Megadja a kulcstitkosítási kulcs helyét Key Vault.

Name Típus Description
keyUrl

string

A kulcstitkosítási kulcsra hivatkozó URL-cím Key Vault.

sourceVault

SubResource

A kulcsot tartalmazó Key Vault relatív URL-címe.

KeyVaultSecretReference

Megadja a lemeztitkosítási kulcs helyét, amely egy Key Vault titkos kód.

Name Típus Description
secretUrl

string

A titkos kódra hivatkozó URL-cím egy Key Vault.

sourceVault

SubResource

A titkos kódot tartalmazó Key Vault relatív URL-címe.

LastPatchInstallationSummary

A virtuális gép legújabb telepítési műveletének telepítési összefoglalása.

Name Típus Description
error

ApiError

A művelet végrehajtása során észlelt hibák. A részletek tömb tartalmazza a lista őket.

excludedPatchCount

integer

Az ügyfél által megadott kizárási lista által explicit módon kizárt összes elérhető javítás száma.

failedPatchCount

integer

A sikertelen telepítést okozó javítások száma.

installationActivityId

string

Az eredményt eredményező művelet tevékenységazonosítója. A CRP- és a bővítménynaplók közötti korrelációra szolgál.

installedPatchCount

integer

A sikeresen telepített javítások száma.

lastModifiedTime

string

A művelet kezdetének UTC időbélyege.

maintenanceWindowExceeded

boolean

Azt ismerteti, hogy a művelet túllépte-e az időkorlátot, mielőtt az összes kívánt műveletet végrehajtotta volna.

notSelectedPatchCount

integer

Az összes elérhető javítás száma, de nem lesz telepítve, mert nem egyezik a besorolási vagy a belefoglalási lista bejegyzésével.

pendingPatchCount

integer

A javítástelepítési művelet során várhatóan telepíteni kívánt összes elérhető javítás száma.

startTime

string

A művelet kezdetének UTC időbélyege.

status

PatchOperationStatus

A művelet általános sikeres vagy sikertelen állapota. A művelet befejezéséig "InProgress" marad. Ekkor "Ismeretlen", "Sikertelen", "Sikeres" vagy "CompletedWithWarnings" lesz.

MaintenanceOperationResultCodeTypes

Az utolsó karbantartási művelet eredménykódja.

Name Típus Description
MaintenanceAborted

string

MaintenanceCompleted

string

None

string

RetryLater

string

MaintenanceRedeployStatus

A karbantartási művelet állapota a virtuális gépen.

Name Típus Description
isCustomerInitiatedMaintenanceAllowed

boolean

Igaz, ha az ügyfél elvégezhet karbantartást.

lastOperationMessage

string

Az utolsó karbantartási művelethez visszaadott üzenet.

lastOperationResultCode

MaintenanceOperationResultCodeTypes

Az utolsó karbantartási művelet eredménykódja.

maintenanceWindowEndTime

string

A karbantartási időszak befejezési ideje.

maintenanceWindowStartTime

string

A karbantartási időszak kezdési időpontja.

preMaintenanceWindowEndTime

string

A karbantartás előtti időszak befejezési ideje.

preMaintenanceWindowStartTime

string

A karbantartási időszak kezdési időpontja.

PatchOperationStatus

A művelet általános sikeres vagy sikertelen állapota. A művelet befejezéséig "InProgress" marad. Ekkor "Ismeretlen", "Sikertelen", "Sikeres" vagy "CompletedWithWarnings" lesz.

Name Típus Description
CompletedWithWarnings

string

Failed

string

InProgress

string

Succeeded

string

Unknown

string

StatusLevelTypes

A szintkód.

Name Típus Description
Error

string

Info

string

Warning

string

SubResource

A titkos kódot tartalmazó Key Vault relatív URL-címe.

Name Típus Description
id

string

Erőforrás-azonosító

VirtualMachineAgentInstanceView

A virtuális gépen futó virtuálisgép-ügynök.

Name Típus Description
extensionHandlers

VirtualMachineExtensionHandlerInstanceView[]

A virtuálisgép-bővítménykezelő példánynézete.

statuses

InstanceViewStatus[]

Az erőforrás állapotadatai.

vmAgentVersion

string

A virtuálisgép-ügynök teljes verziója.

VirtualMachineExtensionHandlerInstanceView

A virtuálisgép-bővítménykezelő példánynézete.

Name Típus Description
status

InstanceViewStatus

A bővítménykezelő állapota.

type

string

Megadja a bővítmény típusát; Ilyen például a "CustomScriptExtension".

typeHandlerVersion

string

A szkriptkezelő verzióját adja meg.

VirtualMachineExtensionInstanceView

A bővítmények adatai.

Name Típus Description
name

string

A virtuális gép bővítményének neve.

statuses

InstanceViewStatus[]

Az erőforrás állapotadatai.

substatuses

InstanceViewStatus[]

Az erőforrás állapotadatai.

type

string

Megadja a bővítmény típusát; Ilyen például a "CustomScriptExtension".

typeHandlerVersion

string

A szkriptkezelő verzióját adja meg.

VirtualMachineHealthStatus

A virtuális gép állapota.

Name Típus Description
status

InstanceViewStatus

A virtuális gép állapotinformációi.

VirtualMachineInstanceView

Egy virtuális gép példánynézete.

Name Típus Description
assignedHost

string

Annak a dedikált gazdagépnek az erőforrás-azonosítója, amelyen a virtuális gép automatikus elhelyezéssel van lefoglalva, ha a virtuális gép egy olyan dedikált gazdagépcsoporthoz van társítva, amelyen engedélyezve van az automatikus elhelyezés. Minimális API-verzió: 2020-06-01.

bootDiagnostics

BootDiagnosticsInstanceView

A rendszerindítási diagnosztika egy hibakeresési funkció, amellyel megtekintheti a konzol kimenetét és képernyőképét a virtuális gép állapotának diagnosztizálásához. A konzolnapló kimenetét egyszerűen megtekintheti. Az Azure lehetővé teszi a virtuális gép képernyőképének megtekintését is a hipervizorból.

computerName

string

A virtuális géphez rendelt számítógépnév.

disks

DiskInstanceView[]

A virtuális gép lemezadatai.

extensions

VirtualMachineExtensionInstanceView[]

A bővítmények adatai.

hyperVGeneration

HyperVGenerationType

Megadja az erőforráshoz társított HyperVGeneration-típust

isVMInStandbyPool

boolean

[Előzetes verziójú funkció] Meghatározza, hogy a virtuális gép jelenleg a készenléti készletben van-e vagy sem.

maintenanceRedeployStatus

MaintenanceRedeployStatus

A karbantartási művelet állapota a virtuális gépen.

osName

string

A virtuális gépen futó operációs rendszer.

osVersion

string

A virtuális gépen futó operációs rendszer verziója.

patchStatus

VirtualMachinePatchStatus

[Előzetes verziójú funkció] A virtuális gépek javítási műveleteinek állapota.

platformFaultDomain

integer

Megadja a virtuális gép tartalék tartományát.

platformUpdateDomain

integer

Megadja a virtuális gép frissítési tartományát.

rdpThumbPrint

string

A távoli asztali tanúsítvány ujjlenyomata.

statuses

InstanceViewStatus[]

Az erőforrás állapotadatai.

vmAgent

VirtualMachineAgentInstanceView

A virtuális gépen futó virtuálisgép-ügynök.

vmHealth

VirtualMachineHealthStatus

A virtuális gép állapota.

VirtualMachinePatchStatus

[Előzetes verziójú funkció] A virtuális gépek javítási műveleteinek állapota.

Name Típus Description
availablePatchSummary

AvailablePatchSummary

A virtuális gép legújabb értékelési műveletének elérhető javítási összefoglalása.

configurationStatuses

InstanceViewStatus[]

A megadott patchMode engedélyezési állapota

lastPatchInstallationSummary

LastPatchInstallationSummary

A virtuális gép legújabb telepítési műveletének telepítési összefoglalása.