你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Virtual Machines - Instance View

  • 参考
Service:
Compute
API Version:
2024-03-01

检索有关虚拟机的运行时状态的信息。

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

URI 参数

名称 在 必需 类型 说明
resourceGroupName
 path True

string

资源组的名称。
subscriptionId
 path True

string

唯一标识 Microsoft Azure 订阅的订阅凭据。 此订阅 ID 是每个服务调用的 URI 的一部分。
vmName
 path True

string

虚拟机的名称。
api-version
 query True

string

客户端 API 版本。

响应

名称 类型 说明
200 OK

VirtualMachineInstanceView

确定
Other Status Codes

CloudError

描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

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

Scopes

名称 说明
user_impersonation 模拟用户帐户

示例

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

Status code:
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": "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

Status code:
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"
    }
  ]
}

定义

名称 说明
ApiError

Api 错误。
ApiErrorBase

Api 错误基。
AvailablePatchSummary

虚拟机最新评估操作的可用修补程序摘要。
BootDiagnosticsInstanceView

启动诊断是一项调试功能，可用于查看控制台输出和屏幕截图以诊断 VM 状态。 可以轻松查看控制台日志的输出。 Azure 还使你能够查看虚拟机监控程序中 VM 的屏幕截图。
CloudError

来自计算服务的错误响应。
DiskEncryptionSettings

指定 OS 磁盘的加密设置。

最低 API 版本：2015-06-15
DiskInstanceView

虚拟机磁盘信息。
HyperVGenerationType

指定与资源关联的 HyperVGeneration 类型
InnerError

内部错误详细信息。
InstanceViewStatus

实例视图状态。
KeyVaultKeyReference

指定密钥加密密钥在 密钥保管库 中的位置。
KeyVaultSecretReference

指定磁盘加密密钥的位置，这是密钥保管库机密。
LastPatchInstallationSummary

虚拟机的最新安装操作的安装摘要。
MaintenanceOperationResultCodeTypes

上次维护操作结果代码。
MaintenanceRedeployStatus

虚拟机上的“维护操作”状态。
PatchOperationStatus

操作的总体成功或失败状态。 在操作完成之前，它将保持“InProgress”。 此时，它将变为“Unknown”、“Failed”、“Succeeded”或“CompletedWithWarnings”。
StatusLevelTypes

级别代码。
SubResource

包含机密的密钥保管库的相对 URL。
VirtualMachineAgentInstanceView

在虚拟机上运行的 VM 代理。
VirtualMachineExtensionHandlerInstanceView

虚拟机扩展处理程序实例视图。
VirtualMachineExtensionInstanceView

扩展信息。
VirtualMachineHealthStatus

VM 的运行状况状态。
VirtualMachineInstanceView

虚拟机的实例视图。
VirtualMachinePatchStatus

[预览功能]虚拟机修补操作的状态。

ApiError

Api 错误。

名称 类型 说明
code

string

错误代码。
details

ApiErrorBase[]

Api 错误详细信息
innererror

InnerError

Api 内部错误
message

string

错误消息。
target

string

特定错误的目标。

ApiErrorBase

Api 错误基。

名称 类型 说明
code

string

错误代码。
message

string

错误消息。
target

string

特定错误的目标。

AvailablePatchSummary

虚拟机最新评估操作的可用修补程序摘要。

名称 类型 说明
assessmentActivityId

string

生成此结果的操作的活动 ID。 它用于跨 CRP 和扩展日志进行关联。
criticalAndSecurityPatchCount

integer

已检测为可用但尚未安装的关键或安全修补程序的数量。
error

ApiError

执行操作期间遇到的错误。 details 数组包含它们的列表。
lastModifiedTime

string

操作开始时的 UTC 时间戳。
otherPatchCount

integer

所有可用修补程序的数量，不包括关键修补程序和安全性。
rebootPending

boolean

VM 的总体重启状态。 如果部分安装的修补程序需要重新启动才能完成安装，但尚未重新启动，则为 true。
startTime

string

操作开始时的 UTC 时间戳。
status

PatchOperationStatus

操作的总体成功或失败状态。 在操作完成之前，它将保持“InProgress”。 此时，它将变为“Unknown”、“Failed”、“Succeeded”或“CompletedWithWarnings”。

BootDiagnosticsInstanceView

启动诊断是一项调试功能，可用于查看控制台输出和屏幕截图以诊断 VM 状态。 可以轻松查看控制台日志的输出。 Azure 还使你能够查看虚拟机监控程序中 VM 的屏幕截图。

名称 类型 说明
consoleScreenshotBlobUri

string

控制台屏幕截图 blob URI。 注意：如果当前使用托管存储启用启动诊断，则不会设置此值。
serialConsoleLogBlobUri

string

串行控制台日志 blob URI。 注意：如果当前使用托管存储启用启动诊断，则不会设置此值。
status

InstanceViewStatus

启动诊断 VM 的状态信息。 注意：仅当启用启动诊断时遇到错误时，才会设置它。

CloudError

来自计算服务的错误响应。

名称 类型 说明
error

ApiError

Api 错误。

DiskEncryptionSettings

指定 OS 磁盘的加密设置。

最低 API 版本：2015-06-15

名称 类型 说明
diskEncryptionKey

KeyVaultSecretReference

指定磁盘加密密钥的位置，这是密钥保管库机密。
enabled

boolean

指定是否应在虚拟机上启用磁盘加密。
keyEncryptionKey

KeyVaultKeyReference

指定密钥加密密钥在 密钥保管库 中的位置。

DiskInstanceView

虚拟机磁盘信息。

名称 类型 说明
encryptionSettings

DiskEncryptionSettings[]

指定 OS 磁盘的加密设置。

最低 API 版本：2015-06-15
name

string

磁盘名称。
statuses

InstanceViewStatus[]

资源状态信息。

HyperVGenerationType

指定与资源关联的 HyperVGeneration 类型

名称 类型 说明
V1

string

V2

string

InnerError

内部错误详细信息。

名称 类型 说明
errordetail

string

内部错误消息或异常转储。
exceptiontype

string

异常类型。

InstanceViewStatus

实例视图状态。

名称 类型 说明
code

string

状态代码。
displayStatus

string

状态的简短可本地化标签。
level

StatusLevelTypes

级别代码。
message

string

详细状态消息，包括警报和错误消息。
time

string

状态的时间。

KeyVaultKeyReference

指定密钥加密密钥在 密钥保管库 中的位置。

名称 类型 说明
keyUrl

string

引用 密钥保管库 中密钥加密密钥的 URL。
sourceVault

SubResource

包含密钥的密钥保管库的相对 URL。

KeyVaultSecretReference

指定磁盘加密密钥的位置，这是密钥保管库机密。

名称 类型 说明
secretUrl

string

引用密钥保管库中的机密的 URL。
sourceVault

SubResource

包含机密的密钥保管库的相对 URL。

LastPatchInstallationSummary

虚拟机的最新安装操作的安装摘要。

名称 类型 说明
error

ApiError

执行操作期间遇到的错误。 details 数组包含它们的列表。
excludedPatchCount

integer

所有可用修补程序的数量，但由客户指定的排除列表显式排除。
failedPatchCount

integer

安装失败的修补程序计数。
installationActivityId

string

生成此结果的操作的活动 ID。 它用于跨 CRP 和扩展日志进行关联。
installedPatchCount

integer

成功安装的修补程序计数。
lastModifiedTime

string

操作开始时的 UTC 时间戳。
maintenanceWindowExceeded

boolean

描述操作在完成所有预期操作之前是否用完时间
notSelectedPatchCount

integer

所有可用修补程序的数量，但不会安装，因为它与分类或包含列表条目不匹配。
pendingPatchCount

integer

在修补程序安装操作过程中预期安装的所有可用修补程序的数量。
startTime

string

操作开始时的 UTC 时间戳。
status

PatchOperationStatus

操作的总体成功或失败状态。 在操作完成之前，它将保持“InProgress”。 此时，它将变为“Unknown”、“Failed”、“Succeeded”或“CompletedWithWarnings”。

MaintenanceOperationResultCodeTypes

上次维护操作结果代码。

名称 类型 说明
MaintenanceAborted

string

MaintenanceCompleted

string

None

string

RetryLater

string

MaintenanceRedeployStatus

虚拟机上的“维护操作”状态。

名称 类型 说明
isCustomerInitiatedMaintenanceAllowed

boolean

如此，如果允许客户执行维护。
lastOperationMessage

string

为上次维护操作返回的消息。
lastOperationResultCode

MaintenanceOperationResultCodeTypes

上次维护操作结果代码。
maintenanceWindowEndTime

string

维护时段的结束时间。
maintenanceWindowStartTime

string

维护时段的开始时间。
preMaintenanceWindowEndTime

string

“维护前”时段的结束时间。
preMaintenanceWindowStartTime

string

“维护前”时段的开始时间。

PatchOperationStatus

操作的总体成功或失败状态。 在操作完成之前，它将保持“InProgress”。 此时，它将变为“Unknown”、“Failed”、“Succeeded”或“CompletedWithWarnings”。

名称 类型 说明
CompletedWithWarnings

string

Failed

string

InProgress

string

Succeeded

string

Unknown

string

StatusLevelTypes

级别代码。

名称 类型 说明
Error

string

Info

string

Warning

string

SubResource

包含机密的密钥保管库的相对 URL。

名称 类型 说明
id

string

资源 ID

VirtualMachineAgentInstanceView

在虚拟机上运行的 VM 代理。

名称 类型 说明
extensionHandlers

VirtualMachineExtensionHandlerInstanceView[]

虚拟机扩展处理程序实例视图。
statuses

InstanceViewStatus[]

资源状态信息。
vmAgentVersion

string

VM 代理完整版本。

VirtualMachineExtensionHandlerInstanceView

虚拟机扩展处理程序实例视图。

名称 类型 说明
status

InstanceViewStatus

扩展处理程序状态。
type

string

指定扩展的类型;例如“CustomScriptExtension”。
typeHandlerVersion

string

指定脚本处理程序的版本。

VirtualMachineExtensionInstanceView

扩展信息。

名称 类型 说明
name

string

虚拟机扩展名称。
statuses

InstanceViewStatus[]

资源状态信息。
substatuses

InstanceViewStatus[]

资源状态信息。
type

string

指定扩展的类型;例如“CustomScriptExtension”。
typeHandlerVersion

string

指定脚本处理程序的版本。

VirtualMachineHealthStatus

VM 的运行状况状态。

名称 类型 说明
status

InstanceViewStatus

VM 的运行状况信息。

VirtualMachineInstanceView

虚拟机的实例视图。

名称 类型 说明
assignedHost

string

当虚拟机与启用了自动放置的专用主机组关联时，专用主机的资源 ID（通过自动放置在该主机上分配虚拟机）。 最低 API 版本：2020-06-01。
bootDiagnostics

BootDiagnosticsInstanceView

启动诊断是一项调试功能，可用于查看控制台输出和屏幕截图以诊断 VM 状态。 可以轻松查看控制台日志的输出。 Azure 还使你能够查看虚拟机监控程序中 VM 的屏幕截图。
computerName

string

分配给虚拟机的计算机名称。
disks

DiskInstanceView[]

虚拟机磁盘信息。
extensions

VirtualMachineExtensionInstanceView[]

扩展信息。
hyperVGeneration

HyperVGenerationType

指定与资源关联的 HyperVGeneration 类型
isVMInStandbyPool

boolean

[预览功能]指定 VM 当前是进入还是退出备用池。
maintenanceRedeployStatus

MaintenanceRedeployStatus

虚拟机上的“维护操作”状态。
osName

string

在虚拟机上运行的操作系统。
osVersion

string

虚拟机上运行的操作系统版本。
patchStatus

VirtualMachinePatchStatus

[预览功能]虚拟机修补操作的状态。
platformFaultDomain

integer

指定虚拟机的容错域。
platformUpdateDomain

integer

指定虚拟机的更新域。
rdpThumbPrint

string

远程桌面证书指纹。
statuses

InstanceViewStatus[]

资源状态信息。
vmAgent

VirtualMachineAgentInstanceView

在虚拟机上运行的 VM 代理。
vmHealth

VirtualMachineHealthStatus

VM 的运行状况状态。

VirtualMachinePatchStatus

[预览功能]虚拟机修补操作的状态。

名称 类型 说明
availablePatchSummary

AvailablePatchSummary

虚拟机最新评估操作的可用修补程序摘要。
configurationStatuses

InstanceViewStatus[]

指定 patchMode 的启用状态
lastPatchInstallationSummary

LastPatchInstallationSummary

虚拟机的最新安装操作的安装摘要。