Partilhar via


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=2024-03-01

Parâmetros do URI

Name Em Necessário Tipo Description
resourceGroupName
path True

string

O nome do grupo de recursos.

subscriptionId
path True

string

Credenciais de assinatura que identificam exclusivamente a assinatura do Microsoft Azure. O ID da assinatura faz parte do URI de cada chamada de serviço.

vmName
path True

string

O nome da máquina virtual.

api-version
query True

string

Versão da API do cliente.

Respostas

Name Tipo Description
200 OK

VirtualMachineInstanceView

OK

Other Status Codes

CloudError

Resposta de erro descrevendo por que a operação falhou.

Segurança

azure_auth

Azure Ative Directory OAuth2 Flow

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

Âmbitos

Name Description
user_impersonation personificar a sua conta de utilizador

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.

Pedido de amostra

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

Resposta da amostra

{
  "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.

Pedido de amostra

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

Resposta da amostra

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

Name Description
ApiError

Erro de api.

ApiErrorBase

Base de erro da api.

AvailablePatchSummary

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

BootDiagnosticsInstanceView

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

CloudError

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

DiskEncryptionSettings

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

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

DiskInstanceView

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

HyperVGenerationType

Especifica o tipo de HyperVGeneration associado a um recurso

InnerError

Detalhes do erro interno.

InstanceViewStatus

Status da exibição da instância.

KeyVaultKeyReference

Especifica o local da chave de criptografia de chave no Cofre da Chave.

KeyVaultSecretReference

Especifica o local da chave de criptografia de disco, que é um segredo do Cofre da Chave.

LastPatchInstallationSummary

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

MaintenanceOperationResultCodeTypes

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

MaintenanceRedeployStatus

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

PatchOperationStatus

O status geral de sucesso ou falha da operação. Ele permanece "InProgress" até que a operação seja concluída. Nesse ponto, ele se tornará "Desconhecido", "Falhado", "Sucedido" ou "CompletedWithWarnings".

StatusLevelTypes

O código de nível.

SubResource

O URL relativo do Cofre da Chave que contém o segredo.

VirtualMachineAgentInstanceView

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

VirtualMachineExtensionHandlerInstanceView

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

VirtualMachineExtensionInstanceView

As informações de extensões.

VirtualMachineHealthStatus

O status de integridade da VM.

VirtualMachineInstanceView

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

VirtualMachinePatchStatus

[Funcionalidade de pré-visualização] O status das operações de patch de máquina virtual.

ApiError

Erro de api.

Name Tipo Description
code

string

O código de erro.

details

ApiErrorBase[]

Os detalhes do erro Api

innererror

InnerError

O erro interno da Api

message

string

A mensagem de erro.

target

string

O alvo do erro específico.

ApiErrorBase

Base de erro da api.

Name Tipo Description
code

string

O código de erro.

message

string

A mensagem de erro.

target

string

O alvo do erro específico.

AvailablePatchSummary

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

Name Tipo Description
assessmentActivityId

string

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

criticalAndSecurityPatchCount

integer

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

error

ApiError

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

lastModifiedTime

string

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

otherPatchCount

integer

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

rebootPending

boolean

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

startTime

string

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

status

PatchOperationStatus

O status geral de sucesso ou falha da operação. Ele permanece "InProgress" até que a operação seja concluída. Nesse ponto, ele se tornará "Desconhecido", "Falhado", "Sucedido" ou "CompletedWithWarnings".

BootDiagnosticsInstanceView

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

Name Tipo Description
consoleScreenshotBlobUri

string

O URI de blob da captura de tela do console. Nota: Isso não será definido se o diagnóstico de inicialização estiver atualmente habilitado com armazenamento gerenciado.

serialConsoleLogBlobUri

string

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

status

InstanceViewStatus

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

CloudError

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

Name Tipo Description
error

ApiError

Erro de api.

DiskEncryptionSettings

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

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

Name Tipo Description
diskEncryptionKey

KeyVaultSecretReference

Especifica o local da chave de criptografia de disco, que é um segredo do Cofre da Chave.

enabled

boolean

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

keyEncryptionKey

KeyVaultKeyReference

Especifica o local da chave de criptografia de chave no Cofre da Chave.

DiskInstanceView

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

Name 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.

HyperVGenerationType

Especifica o tipo de HyperVGeneration associado a um recurso

Name Tipo Description
V1

string

V2

string

InnerError

Detalhes do erro interno.

Name Tipo Description
errordetail

string

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

exceptiontype

string

O tipo de exceção.

InstanceViewStatus

Status da exibição da instância.

Name Tipo Description
code

string

O código de status.

displayStatus

string

O rótulo curto localizável 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

A hora do status.

KeyVaultKeyReference

Especifica o local da chave de criptografia de chave no Cofre da Chave.

Name Tipo Description
keyUrl

string

O URL que faz referência a uma chave de criptografia de chave no Cofre da Chave.

sourceVault

SubResource

O URL relativo do Cofre da Chave que contém a chave.

KeyVaultSecretReference

Especifica o local da chave de criptografia de disco, que é um segredo do Cofre da Chave.

Name Tipo Description
secretUrl

string

O URL que faz referência a um segredo em um Cofre de Chaves.

sourceVault

SubResource

O URL relativo do Cofre da Chave que contém o segredo.

LastPatchInstallationSummary

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

Name Tipo Description
error

ApiError

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

excludedPatchCount

integer

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

failedPatchCount

integer

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

installationActivityId

string

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

installedPatchCount

integer

A contagem de patches instalados com êxito.

lastModifiedTime

string

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

O número de todos os patches disponíveis, mas que não serão instalados porque não corresponderam a uma entrada de classificação ou lista de inclusão.

pendingPatchCount

integer

O número de todos os patches disponíveis que se espera que sejam instalados durante a operação de instalação do patch.

startTime

string

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

status

PatchOperationStatus

O status geral de sucesso ou falha da operação. Ele permanece "InProgress" até que a operação seja concluída. Nesse ponto, ele se tornará "Desconhecido", "Falhado", "Sucedido" ou "CompletedWithWarnings".

MaintenanceOperationResultCodeTypes

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

Name Tipo Description
MaintenanceAborted

string

MaintenanceCompleted

string

None

string

RetryLater

string

MaintenanceRedeployStatus

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

Name Tipo Description
isCustomerInitiatedMaintenanceAllowed

boolean

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

lastOperationMessage

string

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

lastOperationResultCode

MaintenanceOperationResultCodeTypes

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

maintenanceWindowEndTime

string

Hora de Fim da Janela de Manutenção.

maintenanceWindowStartTime

string

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

preMaintenanceWindowEndTime

string

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

preMaintenanceWindowStartTime

string

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

PatchOperationStatus

O status geral de sucesso ou falha da operação. Ele permanece "InProgress" até que a operação seja concluída. Nesse ponto, ele se tornará "Desconhecido", "Falhado", "Sucedido" ou "CompletedWithWarnings".

Name Tipo Description
CompletedWithWarnings

string

Failed

string

InProgress

string

Succeeded

string

Unknown

string

StatusLevelTypes

O código de nível.

Name Tipo Description
Error

string

Info

string

Warning

string

SubResource

O URL relativo do Cofre da Chave que contém o segredo.

Name Tipo Description
id

string

ID do recurso

VirtualMachineAgentInstanceView

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

Name Tipo Description
extensionHandlers

VirtualMachineExtensionHandlerInstanceView[]

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

statuses

InstanceViewStatus[]

As informações de status do recurso.

vmAgentVersion

string

A versão completa do VM Agent.

VirtualMachineExtensionHandlerInstanceView

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

Name 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

As informações de extensões.

Name 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.

Name Tipo Description
status

InstanceViewStatus

As informações de status de integridade para a VM.

VirtualMachineInstanceView

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

Name 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 está associada a um grupo de hosts dedicados que tem o posicionamento automático habilitado. Versão api mínima: 2020-06-01.

bootDiagnostics

BootDiagnosticsInstanceView

O Diagnóstico de Inicialização é um recurso de depuração que permite visualizar a saída do console e a captura de tela para diagnosticar o status da VM. Você pode visualizar facilmente a saída do log do console. O Azure também permite que você veja uma captura de tela da VM do 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 HyperVGeneration associado a um recurso

isVMInStandbyPool

boolean

[Funcionalidade de pré-visualização] Especifica se a VM está atualmente dentro ou fora do Pool em Espera.

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

[Funcionalidade de pré-visualização] O status das operações de patch de máquina virtual.

platformFaultDomain

integer

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

platformUpdateDomain

integer

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

[Funcionalidade de pré-visualização] O status das operações de patch de máquina virtual.

Name Tipo Description
availablePatchSummary

AvailablePatchSummary

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

configurationStatuses

InstanceViewStatus[]

O status de ativação do patchMode especificado

lastPatchInstallationSummary

LastPatchInstallationSummary

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