Virtual Machines - Instance View

Recupera informações sobre o estado de tempo de execução de uma máquina virtual.

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
resourceGroupName
path True

string

minLength: 1
maxLength: 90

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

subscriptionId
path True

string

minLength: 1

O ID da assinatura de destino.

vmName
path True

string

O nome da máquina virtual.

api-version
query True

string

minLength: 1

A versão da API a ser usada para esta operação.

Respostas

Nome Tipo Description
200 OK

VirtualMachineInstanceView

Operação do Azure concluída com sucesso.

Other Status Codes

CloudError

Uma resposta de erro inesperada.

Segurança

azure_auth

Azure Active Directory OAuth2 Flow.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome Description
user_impersonation representar sua conta de usuário

Exemplos

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.

Solicitação de exemplo

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

Resposta de exemplo

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

Get Virtual Machine Instance View.

Solicitação de exemplo

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

Resposta de exemplo

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

Definições

Nome Description
ApiError

Erro de API.

ApiErrorBase

Base de erros de API.

AvailablePatchSummary

Descreve as propriedades de uma exibição de instância de máquina virtual para o resumo de patch disponível.

BootDiagnosticsInstanceView

A exibição de instância de um diagnóstico de inicialização de máquina virtual.

CloudError

Uma resposta de erro do serviço de computação.

DiskEncryptionSettings

Descreve uma configuração de criptografia para um disco

DiskInstanceView

A exibição de instância do disco.

HyperVGenerationType

Especifica o tipo de hipervgeração associado a um recurso

InnerError

Detalhes do erro interno.

InstanceViewStatus

Status da exibição da instância.

KeyVaultKeyReference

Descreve uma referência ao Key Vault Key

KeyVaultSecretReference

Descreve uma referência a Key Vault Secret

LastPatchInstallationSummary

Descreve as propriedades do último resumo de patch instalado.

MaintenanceOperationResultCodeTypes

O último código de resultado da operação de manutenção.

MaintenanceRedeployStatus

Status da operação de manutenção.

PatchOperationStatus

O êxito geral ou o status de falha da operação. Ele permanece "InProgress" até que a operação seja concluída. Nesse ponto, ele se tornará "Desconhecido", "Falhou", "Bem-sucedido" ou "CompletedWithWarnings".

StatusLevelTypes

O código de nível.

StorageAlignmentStatus

Especifica o status de alinhamento de armazenamento do disco.

SubResource
VirtualMachineAgentInstanceView

A exibição de instância do Agente de VM em execução na máquina virtual.

VirtualMachineExtensionHandlerInstanceView

A exibição de instância de um manipulador de extensão de máquina virtual.

VirtualMachineExtensionInstanceView

A exibição de instância de uma extensão de máquina virtual.

VirtualMachineHealthStatus

O status de integridade da VM.

VirtualMachineInstanceView

A exibição de instância de uma máquina virtual.

VirtualMachinePatchStatus

O status das operações de patch de máquina virtual.

ApiError

Erro de API.

Nome Tipo Description
code

string

O código de erro.

details

ApiErrorBase[]

Os detalhes do erro da API

innererror

InnerError

O erro interno da API

message

string

A mensagem de erro.

target

string

O destino do erro específico.

ApiErrorBase

Base de erros de API.

Nome Tipo Description
code

string

O código de erro.

message

string

A mensagem de erro.

target

string

O destino do erro específico.

AvailablePatchSummary

Descreve as propriedades de uma exibição de instância de máquina virtual para o resumo de patch disponível.

Nome Tipo Description
assessmentActivityId

string

A ID da atividade da operação que produziu esse resultado. Ele é usado para correlacionar entre CRP e logs de extensão.

criticalAndSecurityPatchCount

integer (int32)

O número de patches críticos ou de segurança detectados como disponíveis e ainda não instalados.

error

ApiError

Os erros encontrados durante a execução da operação. A matriz de detalhes contém a lista deles.

lastModifiedTime

string (date-time)

O carimbo de data/hora UTC quando a operação começou.

otherPatchCount

integer (int32)

O número de todos os patches disponíveis, excluindo críticos e de segurança.

rebootPending

boolean

O status geral da reinicialização da VM. Ele será verdadeiro quando patches parcialmente instalados exigirem uma reinicialização para concluir a instalação, mas a reinicialização ainda não ocorreu.

startTime

string (date-time)

O carimbo de data/hora UTC quando a operação começou.

status

PatchOperationStatus

O êxito geral ou o status de falha da operação. Ele permanece "InProgress" até que a operação seja concluída. Nesse ponto, ele se tornará "Desconhecido", "Falhou", "Bem-sucedido" ou "CompletedWithWarnings".

BootDiagnosticsInstanceView

A exibição de instância de um diagnóstico de inicialização de máquina virtual.

Nome Tipo Description
consoleScreenshotBlobUri

string

O URI do blob de captura de tela do console. Observação: Isso não ser definido se o diagnóstico de inicialização estiver habilitado no momento com o armazenamento gerenciado.

serialConsoleLogBlobUri

string

O Uri do blob de log do console serial. Observação: Isso não ser definido se o diagnóstico de inicialização estiver habilitado no momento com o armazenamento gerenciado.

status

InstanceViewStatus

As informações de status de diagnóstico de inicialização para a VM. Observação: Ele será definido somente se houver erros encontrados na habilitação do diagnóstico de inicialização.

CloudError

Uma resposta de erro do serviço de computação.

Nome Tipo Description
error

ApiError

Erro de API.

DiskEncryptionSettings

Descreve uma configuração de criptografia para um disco

Nome Tipo Description
diskEncryptionKey

KeyVaultSecretReference

Especifica a localização da chave de criptografia de disco, que é um Key Vault Secret.

enabled

boolean

Especifica se a criptografia de disco deve ser habilitada na máquina virtual.

keyEncryptionKey

KeyVaultKeyReference

Especifica a localização da chave de criptografia de chave no Key Vault.

DiskInstanceView

A exibição de instância do disco.

Nome Tipo Description
encryptionSettings

DiskEncryptionSettings[]

Especifica as configurações de criptografia para o disco do sistema operacional.

Versão mínima da API: 2015-06-15

name

string

O nome do disco.

statuses

InstanceViewStatus[]

As informações de status do recurso.

storageAlignmentStatus

StorageAlignmentStatus

Especifica o status de alinhamento de armazenamento do disco.

HyperVGenerationType

Especifica o tipo de hipervgeração associado a um recurso

Valor Description
V1
V2

InnerError

Detalhes do erro interno.

Nome Tipo Description
errordetail

string

A mensagem de erro interna ou o despejo de exceção.

exceptiontype

string

O tipo de exceção.

InstanceViewStatus

Status da exibição da instância.

Nome Tipo Description
code

string

O código de status.

displayStatus

string

O rótulo localizável curto para o status.

level

StatusLevelTypes

O código de nível.

message

string

A mensagem de status detalhada, inclusive para alertas e mensagens de erro.

time

string (date-time)

A hora do status.

KeyVaultKeyReference

Descreve uma referência ao Key Vault Key

Nome Tipo Description
keyUrl

string

A URL que faz referência a uma chave de criptografia de chave no Key Vault.

sourceVault

SubResource

A URL relativa do Key Vault contendo a chave.

KeyVaultSecretReference

Descreve uma referência a Key Vault Secret

Nome Tipo Description
secretUrl

string

A URL que faz referência a um segredo em um Key Vault.

sourceVault

SubResource

A URL relativa do Key Vault contendo o segredo.

LastPatchInstallationSummary

Descreve as propriedades do último resumo de patch instalado.

Nome Tipo Description
error

ApiError

Os erros encontrados durante a execução da operação. A matriz de detalhes contém a lista deles.

excludedPatchCount

integer (int32)

O número de todos os patches disponíveis, mas excluídos explicitamente por uma correspondência de lista de exclusão especificada pelo cliente.

failedPatchCount

integer (int32)

A contagem de patches que falharam na instalação.

installationActivityId

string

A ID da atividade da operação que produziu esse resultado. Ele é usado para correlacionar entre CRP e logs de extensão.

installedPatchCount

integer (int32)

A contagem de patches instalados com êxito.

lastModifiedTime

string (date-time)

O carimbo de data/hora UTC quando a operação começou.

maintenanceWindowExceeded

boolean

Descreve se a operação ficou sem tempo antes de concluir todas as ações pretendidas

notSelectedPatchCount

integer (int32)

O número de todos os patches disponíveis, mas não será instalado porque ele não correspondeu a uma entrada de lista de classificação ou inclusão.

pendingPatchCount

integer (int32)

O número de todos os patches disponíveis que devem ser instalados ao longo da operação de instalação de patch.

startTime

string (date-time)

O carimbo de data/hora UTC quando a operação começou.

status

PatchOperationStatus

O êxito geral ou o status de falha da operação. Ele permanece "InProgress" até que a operação seja concluída. Nesse ponto, ele se tornará "Desconhecido", "Falhou", "Bem-sucedido" ou "CompletedWithWarnings".

MaintenanceOperationResultCodeTypes

O último código de resultado da operação de manutenção.

Valor Description
None
RetryLater
MaintenanceAborted
MaintenanceCompleted

MaintenanceRedeployStatus

Status da operação de manutenção.

Nome Tipo Description
isCustomerInitiatedMaintenanceAllowed

boolean

True, se o cliente tiver permissão para executar a Manutenção.

lastOperationMessage

string

Mensagem retornada para a última Operação de Manutenção.

lastOperationResultCode

MaintenanceOperationResultCodeTypes

O último código de resultado da operação de manutenção.

maintenanceWindowEndTime

string (date-time)

Hora de término para a janela de manutenção.

maintenanceWindowStartTime

string (date-time)

Hora de início da janela de manutenção.

preMaintenanceWindowEndTime

string (date-time)

Hora de término para a janela de pré-manutenção.

preMaintenanceWindowStartTime

string (date-time)

Hora de início da janela de pré-manutenção.

PatchOperationStatus

O êxito geral ou o status de falha da operação. Ele permanece "InProgress" até que a operação seja concluída. Nesse ponto, ele se tornará "Desconhecido", "Falhou", "Bem-sucedido" ou "CompletedWithWarnings".

Valor Description
Unknown
InProgress
Failed
Succeeded
CompletedWithWarnings

StatusLevelTypes

O código de nível.

Valor Description
Info
Warning
Error

StorageAlignmentStatus

Especifica o status de alinhamento de armazenamento do disco.

Valor Description
Unaligned

O disco não possui Domínio de Falha de Armazenamento para Calcular o mapeamento do Domínio de Falha. Uma única falha no Domínio de Falha de Armazenamento pode impactar todas as VMs que referenciam esse perfil de disco.

Aligned

O disco possui o Domínio de Falha de Armazenamento para Calcular o mapeamento do Domínio de Falha. A falha do Domínio de Falha de Armazenamento é contida às VMs em um único Domínio de Falha de Computação.

SubResource

Nome Tipo Description
id

string

ID do recurso

VirtualMachineAgentInstanceView

A exibição de instância do Agente de VM em execução na máquina virtual.

Nome Tipo Description
extensionHandlers

VirtualMachineExtensionHandlerInstanceView[]

A exibição da instância do manipulador de extensão da máquina virtual.

statuses

InstanceViewStatus[]

As informações de status do recurso.

vmAgentVersion

string

A versão completa do Agente de VM.

VirtualMachineExtensionHandlerInstanceView

A exibição de instância de um manipulador de extensão de máquina virtual.

Nome Tipo Description
status

InstanceViewStatus

O status do manipulador de extensão.

type

string

Especifica o tipo da extensão; um exemplo é "CustomScriptExtension".

typeHandlerVersion

string

Especifica a versão do manipulador de script.

VirtualMachineExtensionInstanceView

A exibição de instância de uma extensão de máquina virtual.

Nome Tipo Description
name

string

O nome da extensão da máquina virtual.

statuses

InstanceViewStatus[]

As informações de status do recurso.

substatuses

InstanceViewStatus[]

As informações de status do recurso.

type

string

Especifica o tipo da extensão; um exemplo é "CustomScriptExtension".

typeHandlerVersion

string

Especifica a versão do manipulador de script.

VirtualMachineHealthStatus

O status de integridade da VM.

Nome Tipo Description
status

InstanceViewStatus

As informações de status de integridade da VM.

VirtualMachineInstanceView

A exibição de instância de uma máquina virtual.

Nome Tipo Description
assignedHost

string

ID de recurso do host dedicado, no qual a máquina virtual é alocada por meio do posicionamento automático, quando a máquina virtual é associada a um grupo de hosts dedicado que tem o posicionamento automático habilitado. Versão mínima da API: 2020-06-01.

bootDiagnostics

BootDiagnosticsInstanceView

O Diagnóstico de Inicialização é um recurso de depuração que permite exibir a Saída do Console e a Captura de Tela para diagnosticar o status da VM. Você pode exibir facilmente a saída do log do console. O Azure também permite que você veja uma captura de tela da VM pelo hipervisor.

computerName

string

O nome do computador atribuído à máquina virtual.

disks

DiskInstanceView[]

As informações de disco da máquina virtual.

extensions

VirtualMachineExtensionInstanceView[]

As informações de extensões.

hyperVGeneration

HyperVGenerationType

Especifica o tipo de hipervgeração associado a um recurso

isVMInStandbyPool

boolean

[Recurso de visualização] Especifica se a VM está dentro ou fora do pool em espera no momento.

maintenanceRedeployStatus

MaintenanceRedeployStatus

O status da Operação de Manutenção na máquina virtual.

osName

string

O sistema operacional em execução na máquina virtual.

osVersion

string

A versão do Sistema Operacional em execução na máquina virtual.

patchStatus

VirtualMachinePatchStatus

[Recurso de visualização] O status das operações de patch de máquina virtual.

platformFaultDomain

integer (int32)

Especifica o domínio de falha da máquina virtual.

platformUpdateDomain

integer (int32)

Especifica o domínio de atualização da máquina virtual.

rdpThumbPrint

string

A impressão digital do certificado da área de trabalho remota.

statuses

InstanceViewStatus[]

As informações de status do recurso.

vmAgent

VirtualMachineAgentInstanceView

O Agente de VM em execução na máquina virtual.

vmHealth

VirtualMachineHealthStatus

O status de integridade da VM.

VirtualMachinePatchStatus

O status das operações de patch de máquina virtual.

Nome Tipo Description
availablePatchSummary

AvailablePatchSummary

O resumo de patch disponível da operação de avaliação mais recente da máquina virtual.

configurationStatuses

InstanceViewStatus[]

O status de habilitação do patchMode especificado

lastPatchInstallationSummary

LastPatchInstallationSummary

O resumo da instalação da operação de instalação mais recente da máquina virtual.