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=2022-03-01
Parameter URI
| Name | In | Required | Type | Description |
|---|---|---|---|---|
|
resource
|
path | True |
|
Nama grup sumber daya. |
|
subscription
|
path | True |
|
Kredensial langganan yang secara unik mengidentifikasi langganan Microsoft Azure. ID langganan membentuk bagian dari URI untuk setiap panggilan layanan. |
|
vm
|
path | True |
|
Nama mesin virtual. |
|
api-version
|
query | True |
|
Versi Api Klien. |
Respons
| Name | Type | Description |
|---|---|---|
| 200 OK |
OK |
|
| Other Status Codes |
Respons kesalahan yang menjelaskan mengapa operasi gagal. |
Keamanan
azure_auth
Azure Active Directory Flow OAuth2
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
| Name | Description |
|---|---|
| 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=2022-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": "2022-03-01T23:11:22+00:00"
}
]
},
"disks": [
{
"name": "myOsDisk",
"statuses": [
{
"code": "ProvisioningState/succeeded",
"level": "Info",
"displayStatus": "Provisioning succeeded",
"time": "2022-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": "2022-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=2022-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"
}
]
},
"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
|
Api |
Kesalahan api. |
|
Api |
Basis kesalahan api. |
|
Available |
Menjelaskan properti tampilan instans komputer virtual untuk ringkasan patch yang tersedia. |
|
Boot |
Tampilan instans diagnostik boot komputer virtual. |
|
Cloud |
Respons kesalahan dari layanan Komputasi. |
|
Disk |
Menjelaskan Pengaturan Enkripsi untuk Disk |
|
Disk |
Tampilan instans disk. |
|
Hyper |
Menentukan Jenis HyperVGeneration yang terkait dengan sumber daya |
|
Inner |
Detail kesalahan dalam. |
|
Instance |
Status tampilan instans. |
|
Key |
Menjelaskan referensi ke Kunci Key Vault |
|
Key |
Menjelaskan referensi ke Rahasia Key Vault |
|
Last |
Menjelaskan properti ringkasan patch terakhir yang diinstal. |
|
Maintenance |
Kode Hasil Operasi Pemeliharaan Terakhir. |
|
Maintenance |
Status Operasi Pemeliharaan. |
|
Patch |
Status keberhasilan atau kegagalan operasi secara keseluruhan. Ini tetap "InProgress" sampai operasi selesai. Pada saat itu akan menjadi "Tidak Diketahui", "Gagal", "Berhasil", atau "CompletedWithWarnings." |
|
Status |
Kode tingkat. |
|
Sub |
|
|
Virtual |
Tampilan instans Agen VM yang berjalan di komputer virtual. |
|
Virtual |
Tampilan instans handler ekstensi komputer virtual. |
|
Virtual |
Tampilan instans ekstensi komputer virtual. |
|
Virtual |
Status kesehatan VM. |
|
Virtual |
Tampilan instans komputer virtual. |
|
Virtual |
Status operasi patch komputer virtual. |
ApiError
Kesalahan api.
| Name | Type | Description |
|---|---|---|
| code |
|
Kode kesalahan. |
| details |
Detail kesalahan Api |
|
| innererror |
Kesalahan dalam Api |
|
| message |
|
Pesan kesalahan. |
| target |
|
Target kesalahan tertentu. |
ApiErrorBase
Basis kesalahan api.
| Name | Type | Description |
|---|---|---|
| code |
|
Kode kesalahan. |
| message |
|
Pesan kesalahan. |
| target |
|
Target kesalahan tertentu. |
AvailablePatchSummary
Menjelaskan properti tampilan instans komputer virtual untuk ringkasan patch yang tersedia.
| Name | Type | Description |
|---|---|---|
| assessmentActivityId |
|
ID aktivitas operasi yang menghasilkan hasil ini. Ini digunakan untuk berkorelasi di seluruh log CRP dan ekstensi. |
| criticalAndSecurityPatchCount |
|
Jumlah patch penting atau keamanan yang telah terdeteksi sebagai tersedia dan belum diinstal. |
| error |
Kesalahan yang ditemui selama eksekusi operasi. Array detail berisi daftarnya. |
|
| lastModifiedTime |
|
Tanda waktu UTC ketika operasi dimulai. |
| otherPatchCount |
|
Jumlah semua patch yang tersedia tidak termasuk penting dan keamanan. |
| rebootPending |
|
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 |
|
Tanda waktu UTC ketika operasi dimulai. |
| status |
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
Tampilan instans diagnostik boot komputer virtual.
| Name | Type | Description |
|---|---|---|
| consoleScreenshotBlobUri |
|
URI blob cuplikan layar konsol. |
| serialConsoleLogBlobUri |
|
Uri blob log konsol serial. |
| status |
Informasi status diagnostik boot untuk VM. |
CloudError
Respons kesalahan dari layanan Komputasi.
| Name | Type | Description |
|---|---|---|
| error |
Kesalahan api. |
DiskEncryptionSettings
Menjelaskan Pengaturan Enkripsi untuk Disk
| Name | Type | Description |
|---|---|---|
| diskEncryptionKey |
Menentukan lokasi kunci enkripsi disk, yang merupakan Rahasia Key Vault. |
|
| enabled |
|
Menentukan apakah enkripsi disk harus diaktifkan pada komputer virtual. |
| keyEncryptionKey |
Menentukan lokasi kunci enkripsi kunci di Key Vault. |
DiskInstanceView
Tampilan instans disk.
| Name | Type | Description |
|---|---|---|
| encryptionSettings |
Menentukan pengaturan enkripsi untuk Disk OS. |
|
| name |
|
Nama disk. |
| statuses |
Informasi status sumber daya. |
HyperVGenerationType
Menentukan Jenis HyperVGeneration yang terkait dengan sumber daya
| Name | Type | Description |
|---|---|---|
| V1 |
|
|
| V2 |
|
InnerError
Detail kesalahan dalam.
| Name | Type | Description |
|---|---|---|
| errordetail |
|
Pesan kesalahan internal atau cadangan pengecualian. |
| exceptiontype |
|
Jenis pengecualian. |
InstanceViewStatus
Status tampilan instans.
| Name | Type | Description |
|---|---|---|
| code |
|
Kode status. |
| displayStatus |
|
Label pendek yang dapat dilokalkan untuk status tersebut. |
| level |
Kode tingkat. |
|
| message |
|
Pesan status terperinci, termasuk untuk pemberitahuan dan pesan kesalahan. |
| time |
|
Waktu status. |
KeyVaultKeyReference
Menjelaskan referensi ke Kunci Key Vault
| Name | Type | Description |
|---|---|---|
| keyUrl |
|
URL yang mereferensikan kunci enkripsi kunci di Key Vault. |
| sourceVault |
URL relatif dari Key Vault yang berisi kunci. |
KeyVaultSecretReference
Menjelaskan referensi ke Rahasia Key Vault
| Name | Type | Description |
|---|---|---|
| secretUrl |
|
URL yang mereferensikan rahasia dalam Key Vault. |
| sourceVault |
URL relatif dari Key Vault yang berisi rahasia. |
LastPatchInstallationSummary
Menjelaskan properti ringkasan patch terakhir yang diinstal.
| Name | Type | Description |
|---|---|---|
| error |
Kesalahan yang ditemui selama eksekusi operasi. Array detail berisi daftarnya. |
|
| excludedPatchCount |
|
Jumlah semua patch yang tersedia tetapi dikecualikan secara eksplisit oleh kecocokan daftar pengecualian yang ditentukan pelanggan. |
| failedPatchCount |
|
Jumlah patch yang gagal diinstal. |
| installationActivityId |
|
ID aktivitas operasi yang menghasilkan hasil ini. Ini digunakan untuk berkorelasi di seluruh log CRP dan ekstensi. |
| installedPatchCount |
|
Jumlah patch yang berhasil diinstal. |
| lastModifiedTime |
|
Tanda waktu UTC ketika operasi dimulai. |
| maintenanceWindowExceeded |
|
Menjelaskan apakah operasi kehabisan waktu sebelum menyelesaikan semua tindakan yang dimaksudkan |
| notSelectedPatchCount |
|
Jumlah semua patch yang tersedia tetapi tidak akan diinstal karena tidak cocok dengan entri daftar klasifikasi atau inklusi. |
| pendingPatchCount |
|
Jumlah semua patch yang tersedia yang diharapkan diinstal selama operasi penginstalan patch. |
| startTime |
|
Tanda waktu UTC ketika operasi dimulai. |
| status |
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.
| Name | Type | Description |
|---|---|---|
| MaintenanceAborted |
|
|
| MaintenanceCompleted |
|
|
| None |
|
|
| RetryLater |
|
MaintenanceRedeployStatus
Status Operasi Pemeliharaan.
| Name | Type | Description |
|---|---|---|
| isCustomerInitiatedMaintenanceAllowed |
|
Benar, jika pelanggan diizinkan untuk melakukan Pemeliharaan. |
| lastOperationMessage |
|
Pesan dikembalikan untuk Operasi Pemeliharaan terakhir. |
| lastOperationResultCode |
Kode Hasil Operasi Pemeliharaan Terakhir. |
|
| maintenanceWindowEndTime |
|
Waktu Selesai untuk Jendela Pemeliharaan. |
| maintenanceWindowStartTime |
|
Waktu Mulai untuk Jendela Pemeliharaan. |
| preMaintenanceWindowEndTime |
|
Waktu Selesai untuk Jendela Pra-Pemeliharaan. |
| preMaintenanceWindowStartTime |
|
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."
| Name | Type | Description |
|---|---|---|
| CompletedWithWarnings |
|
|
| Failed |
|
|
| InProgress |
|
|
| Succeeded |
|
|
| Unknown |
|
StatusLevelTypes
Kode tingkat.
| Name | Type | Description |
|---|---|---|
| Error |
|
|
| Info |
|
|
| Warning |
|
SubResource
| Name | Type | Description |
|---|---|---|
| id |
|
ID sumber daya |
VirtualMachineAgentInstanceView
Tampilan instans Agen VM yang berjalan di komputer virtual.
| Name | Type | Description |
|---|---|---|
| extensionHandlers |
Tampilan instans handler ekstensi komputer virtual. |
|
| statuses |
Informasi status sumber daya. |
|
| vmAgentVersion |
|
Versi lengkap Agen VM. |
VirtualMachineExtensionHandlerInstanceView
Tampilan instans handler ekstensi komputer virtual.
| Name | Type | Description |
|---|---|---|
| status |
Status handler ekstensi. |
|
| type |
|
Menentukan jenis ekstensi; contohnya adalah "CustomScriptExtension". |
| typeHandlerVersion |
|
Menentukan versi handler skrip. |
VirtualMachineExtensionInstanceView
Tampilan instans ekstensi komputer virtual.
| Name | Type | Description |
|---|---|---|
| name |
|
Nama ekstensi komputer virtual. |
| statuses |
Informasi status sumber daya. |
|
| substatuses |
Informasi status sumber daya. |
|
| type |
|
Menentukan jenis ekstensi; contohnya adalah "CustomScriptExtension". |
| typeHandlerVersion |
|
Menentukan versi handler skrip. |
VirtualMachineHealthStatus
Status kesehatan VM.
| Name | Type | Description |
|---|---|---|
| status |
Informasi status kesehatan untuk VM. |
VirtualMachineInstanceView
Tampilan instans komputer virtual.
| Name | Type | Description |
|---|---|---|
| assignedHost |
|
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. |
| bootDiagnostics |
Diagnostik Boot adalah fitur penelusuran kesalahan yang memungkinkan Anda melihat Output Konsol dan Cuplikan Layar untuk mendiagnosis status VM. |
|
| computerName |
|
Nama komputer yang ditetapkan ke komputer virtual. |
| disks |
Informasi disk komputer virtual. |
|
| extensions |
Informasi ekstensi. |
|
| hyperVGeneration |
Menentukan Jenis HyperVGeneration yang terkait dengan sumber daya |
|
| maintenanceRedeployStatus |
Status Operasi Pemeliharaan pada komputer virtual. |
|
| osName |
|
Sistem Operasi yang berjalan pada komputer virtual. |
| osVersion |
|
Versi Sistem Operasi yang berjalan pada komputer virtual. |
| patchStatus |
[Fitur Pratinjau] Status operasi patch komputer virtual. |
|
| platformFaultDomain |
|
Menentukan domain kesalahan komputer virtual. |
| platformUpdateDomain |
|
Menentukan domain pembaruan komputer virtual. |
| rdpThumbPrint |
|
Thumbprint sertifikat desktop jarak jauh. |
| statuses |
Informasi status sumber daya. |
|
| vmAgent |
Agen VM yang berjalan pada komputer virtual. |
|
| vmHealth |
Status kesehatan untuk VM. |
VirtualMachinePatchStatus
Status operasi patch komputer virtual.
| Name | Type | Description |
|---|---|---|
| availablePatchSummary |
Ringkasan patch yang tersedia dari operasi penilaian terbaru untuk komputer virtual. |
|
| configurationStatuses |
Status pengaktifan patchMode yang ditentukan |
|
| lastPatchInstallationSummary |
Ringkasan penginstalan operasi penginstalan terbaru untuk komputer virtual. |