Virtual Machines - Instance View

Hämtar information om körningstillståndet för en virtuell dator.

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

URI-parametrar

Name I Obligatorisk Typ Description
resourceGroupName
path True

string

Namnet på resursgruppen.

subscriptionId
path True

string

Prenumerationsautentiseringsuppgifter som unikt identifierar Microsoft Azure-prenumeration. Prenumerations-ID:t utgör en del av URI:n för varje tjänstanrop.

vmName
path True

string

Namnet på den virtuella datorn.

api-version
query True

string

Klient-API-version.

Svar

Name Typ Description
200 OK

VirtualMachineInstanceView

OK

Other Status Codes

CloudError

Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

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 personifiera ditt användarkonto

Exempel

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

Definitioner

Name Description
ApiError

API-fel.

ApiErrorBase

Api-felbas.

AvailablePatchSummary

Den tillgängliga korrigeringssammanfattningen av den senaste utvärderingsåtgärden för den virtuella datorn.

BootDiagnosticsInstanceView

Startdiagnostik är en felsökningsfunktion som gör att du kan visa konsolutdata och skärmbild för att diagnostisera VM-status. Du kan enkelt visa utdata från konsolloggen. Med Azure kan du också se en skärmbild av den virtuella datorn från hypervisor-programmet.

CloudError

Ett felsvar från Beräkningstjänsten.

DiskEncryptionSettings

Anger krypteringsinställningarna för OS-disken.

Lägsta API-version: 2015-06-15

DiskInstanceView

Den virtuella datorns diskinformation.

HyperVGenerationType

Anger den HyperVGeneration-typ som är associerad med en resurs

InnerError

Inre felinformation.

InstanceViewStatus

Status för instansvy.

KeyVaultKeyReference

Anger platsen för nyckelkrypteringsnyckeln i Key Vault.

KeyVaultSecretReference

Anger platsen för diskkrypteringsnyckeln, som är en Key Vault hemlighet.

LastPatchInstallationSummary

Installationssammanfattningen för den senaste installationsåtgärden för den virtuella datorn.

MaintenanceOperationResultCodeTypes

Resultatkoden för den senaste underhållsåtgärden.

MaintenanceRedeployStatus

Status för underhållsåtgärd på den virtuella datorn.

PatchOperationStatus

Åtgärdens övergripande status för lyckade eller misslyckade åtgärder. Den förblir "InProgress" tills åtgärden har slutförts. Då blir den "Okänd", "Misslyckad", "Lyckades" eller "CompletedWithWarnings".

StatusLevelTypes

Nivåkoden.

SubResource

Den relativa URL:en för Key Vault som innehåller hemligheten.

VirtualMachineAgentInstanceView

VM-agenten som körs på den virtuella datorn.

VirtualMachineExtensionHandlerInstanceView

Instansvyn för tilläggshanteraren för virtuella datorer.

VirtualMachineExtensionInstanceView

Tilläggsinformationen.

VirtualMachineHealthStatus

Hälsostatus för den virtuella datorn.

VirtualMachineInstanceView

Instansvyn för en virtuell dator.

VirtualMachinePatchStatus

[Förhandsversionsfunktion] Status för korrigeringsåtgärder för virtuella datorer.

ApiError

API-fel.

Name Typ Description
code

string

Felkoden.

details

ApiErrorBase[]

Api-felinformationen

innererror

InnerError

Api:ets inre fel

message

string

Felmeddelandet.

target

string

Målet för det specifika felet.

ApiErrorBase

Api-felbas.

Name Typ Description
code

string

Felkoden.

message

string

Felmeddelandet.

target

string

Målet för det specifika felet.

AvailablePatchSummary

Den tillgängliga korrigeringssammanfattningen av den senaste utvärderingsåtgärden för den virtuella datorn.

Name Typ Description
assessmentActivityId

string

Aktivitets-ID för åtgärden som genererade det här resultatet. Den används för att korrelera mellan CRP- och tilläggsloggar.

criticalAndSecurityPatchCount

integer

Antalet kritiska korrigeringar eller säkerhetskorrigeringar som har identifierats som tillgängliga och ännu inte installerats.

error

ApiError

De fel som påträffades under körningen av åtgärden. Informationsmatrisen innehåller listan över dem.

lastModifiedTime

string

UTC-tidsstämpeln när åtgärden påbörjades.

otherPatchCount

integer

Antalet tillgängliga korrigeringar exklusive kritisk och säkerhet.

rebootPending

boolean

Den virtuella datorns övergripande omstartsstatus. Det är sant när delvis installerade korrigeringar kräver en omstart för att slutföra installationen, men omstarten har ännu inte inträffat.

startTime

string

UTC-tidsstämpeln när åtgärden påbörjades.

status

PatchOperationStatus

Åtgärdens övergripande status för lyckade eller misslyckade åtgärder. Den förblir "InProgress" tills åtgärden har slutförts. Då blir den "Okänd", "Misslyckad", "Lyckades" eller "CompletedWithWarnings".

BootDiagnosticsInstanceView

Startdiagnostik är en felsökningsfunktion som gör att du kan visa konsolutdata och skärmbild för att diagnostisera VM-status. Du kan enkelt visa utdata från konsolloggen. Med Azure kan du också se en skärmbild av den virtuella datorn från hypervisor-programmet.

Name Typ Description
consoleScreenshotBlobUri

string

Konsolens skärmbild av blob-URI:n. Observera: Detta anges inte om startdiagnostik för närvarande är aktiverat med hanterad lagring.

serialConsoleLogBlobUri

string

Blob-URI:n för seriekonsolloggen. Observera: Detta anges inte om startdiagnostik för närvarande är aktiverat med hanterad lagring.

status

InstanceViewStatus

Statusinformation för startdiagnostik för den virtuella datorn. Observera: Den anges endast om det uppstår fel vid aktivering av startdiagnostik.

CloudError

Ett felsvar från Beräkningstjänsten.

Name Typ Description
error

ApiError

API-fel.

DiskEncryptionSettings

Anger krypteringsinställningarna för OS-disken.

Lägsta API-version: 2015-06-15

Name Typ Description
diskEncryptionKey

KeyVaultSecretReference

Anger platsen för diskkrypteringsnyckeln, som är en Key Vault hemlighet.

enabled

boolean

Anger om diskkryptering ska aktiveras på den virtuella datorn.

keyEncryptionKey

KeyVaultKeyReference

Anger platsen för nyckelkrypteringsnyckeln i Key Vault.

DiskInstanceView

Den virtuella datorns diskinformation.

Name Typ Description
encryptionSettings

DiskEncryptionSettings[]

Anger krypteringsinställningarna för OS-disken.

Lägsta API-version: 2015-06-15

name

string

Disknamnet.

statuses

InstanceViewStatus[]

Resursstatusinformationen.

HyperVGenerationType

Anger den HyperVGeneration-typ som är associerad med en resurs

Name Typ Description
V1

string

V2

string

InnerError

Inre felinformation.

Name Typ Description
errordetail

string

Det interna felmeddelandet eller undantagsdumpen.

exceptiontype

string

Undantagstypen.

InstanceViewStatus

Status för instansvy.

Name Typ Description
code

string

Statuskoden.

displayStatus

string

Den korta localizable etiketten för statusen.

level

StatusLevelTypes

Nivåkoden.

message

string

Det detaljerade statusmeddelandet, inklusive för aviseringar och felmeddelanden.

time

string

Tiden för statusen.

KeyVaultKeyReference

Anger platsen för nyckelkrypteringsnyckeln i Key Vault.

Name Typ Description
keyUrl

string

URL:en som refererar till en nyckelkrypteringsnyckel i Key Vault.

sourceVault

SubResource

Den relativa URL:en för Key Vault som innehåller nyckeln.

KeyVaultSecretReference

Anger platsen för diskkrypteringsnyckeln, som är en Key Vault hemlighet.

Name Typ Description
secretUrl

string

URL:en som refererar till en hemlighet i en Key Vault.

sourceVault

SubResource

Den relativa URL:en för Key Vault som innehåller hemligheten.

LastPatchInstallationSummary

Installationssammanfattningen för den senaste installationsåtgärden för den virtuella datorn.

Name Typ Description
error

ApiError

De fel som påträffades under körningen av åtgärden. Informationsmatrisen innehåller listan över dem.

excludedPatchCount

integer

Antalet tillgängliga korrigeringar men exkluderas uttryckligen av en kundspecifik undantagslista.

failedPatchCount

integer

Antalet korrigeringar som misslyckades med installationen.

installationActivityId

string

Aktivitets-ID för åtgärden som genererade det här resultatet. Den används för att korrelera mellan CRP- och tilläggsloggar.

installedPatchCount

integer

Antalet korrigeringar som har installerats.

lastModifiedTime

string

UTC-tidsstämpeln när åtgärden påbörjades.

maintenanceWindowExceeded

boolean

Beskriver om åtgärden tog slut innan den slutförde alla avsedda åtgärder

notSelectedPatchCount

integer

Antalet tillgängliga korrigeringar men kommer inte att installeras eftersom det inte matchade en klassificerings- eller inkluderingslista.

pendingPatchCount

integer

Antalet tillgängliga korrigeringar som förväntas installeras under korrigeringsinstallationen.

startTime

string

UTC-tidsstämpeln när åtgärden påbörjades.

status

PatchOperationStatus

Åtgärdens övergripande status för lyckade eller misslyckade åtgärder. Den förblir "InProgress" tills åtgärden har slutförts. Då blir den "Okänd", "Misslyckad", "Lyckades" eller "CompletedWithWarnings".

MaintenanceOperationResultCodeTypes

Resultatkoden för den senaste underhållsåtgärden.

Name Typ Description
MaintenanceAborted

string

MaintenanceCompleted

string

None

string

RetryLater

string

MaintenanceRedeployStatus

Status för underhållsåtgärd på den virtuella datorn.

Name Typ Description
isCustomerInitiatedMaintenanceAllowed

boolean

Sant, om kunden får utföra underhåll.

lastOperationMessage

string

Meddelande som returnerades för den senaste underhållsåtgärden.

lastOperationResultCode

MaintenanceOperationResultCodeTypes

Resultatkoden för den senaste underhållsåtgärden.

maintenanceWindowEndTime

string

Sluttid för underhållsfönstret.

maintenanceWindowStartTime

string

Starttid för underhållsfönstret.

preMaintenanceWindowEndTime

string

Sluttid för fönstret Förunderhåll.

preMaintenanceWindowStartTime

string

Starttid för fönstret Förunderhåll.

PatchOperationStatus

Åtgärdens övergripande status för lyckade eller misslyckade åtgärder. Den förblir "InProgress" tills åtgärden har slutförts. Då blir den "Okänd", "Misslyckad", "Lyckades" eller "CompletedWithWarnings".

Name Typ Description
CompletedWithWarnings

string

Failed

string

InProgress

string

Succeeded

string

Unknown

string

StatusLevelTypes

Nivåkoden.

Name Typ Description
Error

string

Info

string

Warning

string

SubResource

Den relativa URL:en för Key Vault som innehåller hemligheten.

Name Typ Description
id

string

Resurs-ID

VirtualMachineAgentInstanceView

VM-agenten som körs på den virtuella datorn.

Name Typ Description
extensionHandlers

VirtualMachineExtensionHandlerInstanceView[]

Instansvyn för tilläggshanteraren för virtuella datorer.

statuses

InstanceViewStatus[]

Resursstatusinformationen.

vmAgentVersion

string

Vm-agentens fullständiga version.

VirtualMachineExtensionHandlerInstanceView

Instansvyn för tilläggshanteraren för virtuella datorer.

Name Typ Description
status

InstanceViewStatus

Status för tilläggshanteraren.

type

string

Anger filnamnstilläggets typ. ett exempel är "CustomScriptExtension".

typeHandlerVersion

string

Anger versionen av skripthanteraren.

VirtualMachineExtensionInstanceView

Tilläggsinformationen.

Name Typ Description
name

string

Namnet på det virtuella datortillägget.

statuses

InstanceViewStatus[]

Resursstatusinformationen.

substatuses

InstanceViewStatus[]

Resursstatusinformationen.

type

string

Anger filnamnstilläggets typ. ett exempel är "CustomScriptExtension".

typeHandlerVersion

string

Anger versionen av skripthanteraren.

VirtualMachineHealthStatus

Hälsostatus för den virtuella datorn.

Name Typ Description
status

InstanceViewStatus

Hälsostatusinformationen för den virtuella datorn.

VirtualMachineInstanceView

Instansvyn för en virtuell dator.

Name Typ Description
assignedHost

string

Resurs-ID för den dedikerade värden, där den virtuella datorn allokeras via automatisk placering, när den virtuella datorn är associerad med en dedikerad värdgrupp som har automatisk placering aktiverad. Lägsta API-version: 2020-06-01.

bootDiagnostics

BootDiagnosticsInstanceView

Startdiagnostik är en felsökningsfunktion som gör att du kan visa konsolutdata och skärmbild för att diagnostisera VM-status. Du kan enkelt visa utdata från konsolloggen. Med Azure kan du också se en skärmbild av den virtuella datorn från hypervisor-programmet.

computerName

string

Datornamnet som tilldelats den virtuella datorn.

disks

DiskInstanceView[]

Den virtuella datorns diskinformation.

extensions

VirtualMachineExtensionInstanceView[]

Tilläggsinformationen.

hyperVGeneration

HyperVGenerationType

Anger den HyperVGeneration-typ som är associerad med en resurs

isVMInStandbyPool

boolean

[Förhandsversionsfunktion] Anger om den virtuella datorn för närvarande är i eller ut ur väntepoolen.

maintenanceRedeployStatus

MaintenanceRedeployStatus

Status för underhållsåtgärd på den virtuella datorn.

osName

string

Operativsystemet som körs på den virtuella datorn.

osVersion

string

Den version av operativsystemet som körs på den virtuella datorn.

patchStatus

VirtualMachinePatchStatus

[Förhandsversionsfunktion] Status för korrigeringsåtgärder för virtuella datorer.

platformFaultDomain

integer

Anger feldomänen för den virtuella datorn.

platformUpdateDomain

integer

Anger uppdateringsdomänen för den virtuella datorn.

rdpThumbPrint

string

Tumavtrycket fjärrskrivbordscertifikat.

statuses

InstanceViewStatus[]

Resursstatusinformationen.

vmAgent

VirtualMachineAgentInstanceView

VM-agenten som körs på den virtuella datorn.

vmHealth

VirtualMachineHealthStatus

Hälsostatus för den virtuella datorn.

VirtualMachinePatchStatus

[Förhandsversionsfunktion] Status för korrigeringsåtgärder för virtuella datorer.

Name Typ Description
availablePatchSummary

AvailablePatchSummary

Den tillgängliga korrigeringssammanfattningen av den senaste utvärderingsåtgärden för den virtuella datorn.

configurationStatuses

InstanceViewStatus[]

Aktiveringsstatus för den angivna patchMode

lastPatchInstallationSummary

LastPatchInstallationSummary

Installationssammanfattningen för den senaste installationsåtgärden för den virtuella datorn.