Virtual Machines - Instance View

Mengambil informasi tentang status run-time komputer virtual.

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

Parameter URI

Nama Dalam Diperlukan Jenis Deskripsi
resourceGroupName
path True

string

Nama grup sumber daya.

subscriptionId
path True

string

Kredensial langganan yang secara unik mengidentifikasi langganan Microsoft Azure. ID langganan membentuk bagian dari URI untuk setiap panggilan layanan.

vmName
path True

string

Nama mesin virtual.

api-version
query True

string

Versi Api Klien.

Respons

Nama Jenis Deskripsi
200 OK

VirtualMachineInstanceView

OK

Other Status Codes

CloudError

Respons kesalahan yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nama Deskripsi
user_impersonation meniru akun pengguna Anda

Contoh

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

Definisi

Nama Deskripsi
ApiError

Kesalahan api.

ApiErrorBase

Basis kesalahan api.

AvailablePatchSummary

Ringkasan patch yang tersedia dari operasi penilaian terbaru untuk komputer virtual.

BootDiagnosticsInstanceView

Diagnostik Boot adalah fitur penelusuran kesalahan yang memungkinkan Anda melihat Output Konsol dan Cuplikan Layar untuk mendiagnosis status VM. Anda dapat dengan mudah melihat output log konsol Anda. Azure juga memungkinkan Anda melihat cuplikan layar VM dari hypervisor.

CloudError

Respons kesalahan dari layanan Komputasi.

DiskEncryptionSettings

Menentukan pengaturan enkripsi untuk Disk OS.

Versi api minimum: 2015-06-15

DiskInstanceView

Informasi disk komputer virtual.

HyperVGenerationType

Menentukan Jenis HyperVGeneration yang terkait dengan sumber daya

InnerError

Detail kesalahan dalam.

InstanceViewStatus

Status tampilan instans.

KeyVaultKeyReference

Menentukan lokasi kunci enkripsi kunci di Key Vault.

KeyVaultSecretReference

Menentukan lokasi kunci enkripsi disk, yang merupakan Rahasia Key Vault.

LastPatchInstallationSummary

Ringkasan penginstalan operasi penginstalan terbaru untuk komputer virtual.

MaintenanceOperationResultCodeTypes

Kode Hasil Operasi Pemeliharaan Terakhir.

MaintenanceRedeployStatus

Status Operasi Pemeliharaan pada komputer virtual.

PatchOperationStatus

Status keberhasilan atau kegagalan operasi secara keseluruhan. Ini tetap "InProgress" sampai operasi selesai. Pada saat itu akan menjadi "Tidak Diketahui", "Gagal", "Berhasil", atau "CompletedWithWarnings."

StatusLevelTypes

Kode tingkat.

SubResource

URL relatif dari Key Vault yang berisi rahasia.

VirtualMachineAgentInstanceView

Agen VM yang berjalan pada komputer virtual.

VirtualMachineExtensionHandlerInstanceView

Tampilan instans handler ekstensi komputer virtual.

VirtualMachineExtensionInstanceView

Informasi ekstensi.

VirtualMachineHealthStatus

Status kesehatan untuk VM.

VirtualMachineInstanceView

Tampilan instans komputer virtual.

VirtualMachinePatchStatus

[Fitur Pratinjau] Status operasi patch komputer virtual.

ApiError

Kesalahan api.

Nama Jenis Deskripsi
code

string

Kode kesalahan.

details

ApiErrorBase[]

Detail kesalahan Api

innererror

InnerError

Kesalahan dalam Api

message

string

Pesan kesalahan.

target

string

Target kesalahan tertentu.

ApiErrorBase

Basis kesalahan api.

Nama Jenis Deskripsi
code

string

Kode kesalahan.

message

string

Pesan kesalahan.

target

string

Target kesalahan tertentu.

AvailablePatchSummary

Ringkasan patch yang tersedia dari operasi penilaian terbaru untuk komputer virtual.

Nama Jenis Deskripsi
assessmentActivityId

string

ID aktivitas operasi yang menghasilkan hasil ini. Ini digunakan untuk berkorelasi di seluruh log CRP dan ekstensi.

criticalAndSecurityPatchCount

integer

Jumlah patch penting atau keamanan yang telah terdeteksi sebagai tersedia dan belum diinstal.

error

ApiError

Kesalahan yang ditemui selama eksekusi operasi. Array detail berisi daftarnya.

lastModifiedTime

string

Tanda waktu UTC ketika operasi dimulai.

otherPatchCount

integer

Jumlah semua patch yang tersedia tidak termasuk penting dan keamanan.

rebootPending

boolean

Status boot ulang keseluruhan VM. Ini akan benar ketika patch yang diinstal sebagian memerlukan boot ulang untuk menyelesaikan penginstalan tetapi boot ulang belum terjadi.

startTime

string

Tanda waktu UTC ketika operasi dimulai.

status

PatchOperationStatus

Status keberhasilan atau kegagalan operasi secara keseluruhan. Ini tetap "InProgress" sampai operasi selesai. Pada saat itu akan menjadi "Tidak Diketahui", "Gagal", "Berhasil", atau "CompletedWithWarnings."

BootDiagnosticsInstanceView

Diagnostik Boot adalah fitur penelusuran kesalahan yang memungkinkan Anda melihat Output Konsol dan Cuplikan Layar untuk mendiagnosis status VM. Anda dapat dengan mudah melihat output log konsol Anda. Azure juga memungkinkan Anda melihat cuplikan layar VM dari hypervisor.

Nama Jenis Deskripsi
consoleScreenshotBlobUri

string

URI blob cuplikan layar konsol. Catatan: Ini tidak akan diatur jika diagnostik boot saat ini diaktifkan dengan penyimpanan terkelola.

serialConsoleLogBlobUri

string

Uri blob log konsol serial. Catatan: Ini tidak akan diatur jika diagnostik boot saat ini diaktifkan dengan penyimpanan terkelola.

status

InstanceViewStatus

Informasi status diagnostik boot untuk VM. Catatan: Ini akan diatur hanya jika ada kesalahan yang ditemui dalam mengaktifkan diagnostik boot.

CloudError

Respons kesalahan dari layanan Komputasi.

Nama Jenis Deskripsi
error

ApiError

Kesalahan api.

DiskEncryptionSettings

Menentukan pengaturan enkripsi untuk Disk OS.

Versi api minimum: 2015-06-15

Nama Jenis Deskripsi
diskEncryptionKey

KeyVaultSecretReference

Menentukan lokasi kunci enkripsi disk, yang merupakan Rahasia Key Vault.

enabled

boolean

Menentukan apakah enkripsi disk harus diaktifkan pada komputer virtual.

keyEncryptionKey

KeyVaultKeyReference

Menentukan lokasi kunci enkripsi kunci di Key Vault.

DiskInstanceView

Informasi disk komputer virtual.

Nama Jenis Deskripsi
encryptionSettings

DiskEncryptionSettings[]

Menentukan pengaturan enkripsi untuk Disk OS.

Versi api minimum: 2015-06-15

name

string

Nama disk.

statuses

InstanceViewStatus[]

Informasi status sumber daya.

HyperVGenerationType

Menentukan Jenis HyperVGeneration yang terkait dengan sumber daya

Nama Jenis Deskripsi
V1

string

V2

string

InnerError

Detail kesalahan dalam.

Nama Jenis Deskripsi
errordetail

string

Pesan kesalahan internal atau cadangan pengecualian.

exceptiontype

string

Jenis pengecualian.

InstanceViewStatus

Status tampilan instans.

Nama Jenis Deskripsi
code

string

Kode status.

displayStatus

string

Label pendek yang dapat dilokalkan untuk status tersebut.

level

StatusLevelTypes

Kode tingkat.

message

string

Pesan status terperinci, termasuk untuk pemberitahuan dan pesan kesalahan.

time

string

Waktu status.

KeyVaultKeyReference

Menentukan lokasi kunci enkripsi kunci di Key Vault.

Nama Jenis Deskripsi
keyUrl

string

URL yang mereferensikan kunci enkripsi kunci di Key Vault.

sourceVault

SubResource

URL relatif dari Key Vault yang berisi kunci.

KeyVaultSecretReference

Menentukan lokasi kunci enkripsi disk, yang merupakan Rahasia Key Vault.

Nama Jenis Deskripsi
secretUrl

string

URL yang mereferensikan rahasia dalam Key Vault.

sourceVault

SubResource

URL relatif dari Key Vault yang berisi rahasia.

LastPatchInstallationSummary

Ringkasan penginstalan operasi penginstalan terbaru untuk komputer virtual.

Nama Jenis Deskripsi
error

ApiError

Kesalahan yang ditemui selama eksekusi operasi. Array detail berisi daftarnya.

excludedPatchCount

integer

Jumlah semua patch yang tersedia tetapi dikecualikan secara eksplisit oleh kecocokan daftar pengecualian yang ditentukan pelanggan.

failedPatchCount

integer

Jumlah patch yang gagal diinstal.

installationActivityId

string

ID aktivitas operasi yang menghasilkan hasil ini. Ini digunakan untuk berkorelasi di seluruh log CRP dan ekstensi.

installedPatchCount

integer

Jumlah patch yang berhasil diinstal.

lastModifiedTime

string

Tanda waktu UTC ketika operasi dimulai.

maintenanceWindowExceeded

boolean

Menjelaskan apakah operasi kehabisan waktu sebelum menyelesaikan semua tindakan yang dimaksudkan

notSelectedPatchCount

integer

Jumlah semua patch yang tersedia tetapi tidak akan diinstal karena tidak cocok dengan entri daftar klasifikasi atau inklusi.

pendingPatchCount

integer

Jumlah semua patch yang tersedia yang diharapkan diinstal selama operasi penginstalan patch.

startTime

string

Tanda waktu UTC ketika operasi dimulai.

status

PatchOperationStatus

Status keberhasilan atau kegagalan operasi secara keseluruhan. Ini tetap "InProgress" sampai operasi selesai. Pada saat itu akan menjadi "Tidak Diketahui", "Gagal", "Berhasil", atau "CompletedWithWarnings."

MaintenanceOperationResultCodeTypes

Kode Hasil Operasi Pemeliharaan Terakhir.

Nama Jenis Deskripsi
MaintenanceAborted

string

MaintenanceCompleted

string

None

string

RetryLater

string

MaintenanceRedeployStatus

Status Operasi Pemeliharaan pada komputer virtual.

Nama Jenis Deskripsi
isCustomerInitiatedMaintenanceAllowed

boolean

Benar, jika pelanggan diizinkan untuk melakukan Pemeliharaan.

lastOperationMessage

string

Pesan dikembalikan untuk Operasi Pemeliharaan terakhir.

lastOperationResultCode

MaintenanceOperationResultCodeTypes

Kode Hasil Operasi Pemeliharaan Terakhir.

maintenanceWindowEndTime

string

Waktu Selesai untuk Jendela Pemeliharaan.

maintenanceWindowStartTime

string

Waktu Mulai untuk Jendela Pemeliharaan.

preMaintenanceWindowEndTime

string

Waktu Selesai untuk Jendela Pra-Pemeliharaan.

preMaintenanceWindowStartTime

string

Waktu Mulai untuk Jendela Pra-Pemeliharaan.

PatchOperationStatus

Status keberhasilan atau kegagalan operasi secara keseluruhan. Ini tetap "InProgress" sampai operasi selesai. Pada saat itu akan menjadi "Tidak Diketahui", "Gagal", "Berhasil", atau "CompletedWithWarnings."

Nama Jenis Deskripsi
CompletedWithWarnings

string

Failed

string

InProgress

string

Succeeded

string

Unknown

string

StatusLevelTypes

Kode tingkat.

Nama Jenis Deskripsi
Error

string

Info

string

Warning

string

SubResource

URL relatif dari Key Vault yang berisi rahasia.

Nama Jenis Deskripsi
id

string

ID sumber daya

VirtualMachineAgentInstanceView

Agen VM yang berjalan pada komputer virtual.

Nama Jenis Deskripsi
extensionHandlers

VirtualMachineExtensionHandlerInstanceView[]

Tampilan instans handler ekstensi komputer virtual.

statuses

InstanceViewStatus[]

Informasi status sumber daya.

vmAgentVersion

string

Versi lengkap Agen VM.

VirtualMachineExtensionHandlerInstanceView

Tampilan instans handler ekstensi komputer virtual.

Nama Jenis Deskripsi
status

InstanceViewStatus

Status handler ekstensi.

type

string

Menentukan jenis ekstensi; contohnya adalah "CustomScriptExtension".

typeHandlerVersion

string

Menentukan versi handler skrip.

VirtualMachineExtensionInstanceView

Informasi ekstensi.

Nama Jenis Deskripsi
name

string

Nama ekstensi komputer virtual.

statuses

InstanceViewStatus[]

Informasi status sumber daya.

substatuses

InstanceViewStatus[]

Informasi status sumber daya.

type

string

Menentukan jenis ekstensi; contohnya adalah "CustomScriptExtension".

typeHandlerVersion

string

Menentukan versi handler skrip.

VirtualMachineHealthStatus

Status kesehatan untuk VM.

Nama Jenis Deskripsi
status

InstanceViewStatus

Informasi status kesehatan untuk VM.

VirtualMachineInstanceView

Tampilan instans komputer virtual.

Nama Jenis Deskripsi
assignedHost

string

Id sumber daya dari host khusus, tempat komputer virtual dialokasikan melalui penempatan otomatis, ketika komputer virtual dikaitkan dengan grup host khusus yang mengaktifkan penempatan otomatis. Versi api minimum: 2020-06-01.

bootDiagnostics

BootDiagnosticsInstanceView

Diagnostik Boot adalah fitur penelusuran kesalahan yang memungkinkan Anda melihat Output Konsol dan Cuplikan Layar untuk mendiagnosis status VM. Anda dapat dengan mudah melihat output log konsol Anda. Azure juga memungkinkan Anda melihat cuplikan layar VM dari hypervisor.

computerName

string

Nama komputer yang ditetapkan ke komputer virtual.

disks

DiskInstanceView[]

Informasi disk komputer virtual.

extensions

VirtualMachineExtensionInstanceView[]

Informasi ekstensi.

hyperVGeneration

HyperVGenerationType

Menentukan Jenis HyperVGeneration yang terkait dengan sumber daya

isVMInStandbyPool

boolean

[Fitur Pratinjau] Menentukan apakah VM saat ini masuk atau keluar dari Kumpulan Siaga.

maintenanceRedeployStatus

MaintenanceRedeployStatus

Status Operasi Pemeliharaan pada komputer virtual.

osName

string

Sistem Operasi yang berjalan pada komputer virtual.

osVersion

string

Versi Sistem Operasi yang berjalan pada komputer virtual.

patchStatus

VirtualMachinePatchStatus

[Fitur Pratinjau] Status operasi patch komputer virtual.

platformFaultDomain

integer

Menentukan domain kesalahan komputer virtual.

platformUpdateDomain

integer

Menentukan domain pembaruan komputer virtual.

rdpThumbPrint

string

Thumbprint sertifikat desktop jarak jauh.

statuses

InstanceViewStatus[]

Informasi status sumber daya.

vmAgent

VirtualMachineAgentInstanceView

Agen VM yang berjalan pada komputer virtual.

vmHealth

VirtualMachineHealthStatus

Status kesehatan untuk VM.

VirtualMachinePatchStatus

[Fitur Pratinjau] Status operasi patch komputer virtual.

Nama Jenis Deskripsi
availablePatchSummary

AvailablePatchSummary

Ringkasan patch yang tersedia dari operasi penilaian terbaru untuk komputer virtual.

configurationStatuses

InstanceViewStatus[]

Status pengaktifan patchMode yang ditentukan

lastPatchInstallationSummary

LastPatchInstallationSummary

Ringkasan penginstalan operasi penginstalan terbaru untuk komputer virtual.