Virtual Machine Scale Set VMs - Get Instance View

Obtém o status de uma máquina virtual de um conjunto de dimensionamento de VM.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/instanceView?api-version=2022-08-01

Parâmetros de URI

Name In Required Type Description
instanceId
path True
  • string

A ID da instância da máquina virtual.

resourceGroupName
path True
  • string

O nome do grupo de recursos.

subscriptionId
path True
  • string

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

vmScaleSetName
path True
  • string

O nome do conjunto de dimensionamento de VM.

api-version
query True
  • string

Versão da API do Cliente.

Respostas

Name Type Description
200 OK

OK

Other Status Codes

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

Segurança

azure_auth

Flow Azure Active Directory OAuth2

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

Scopes

Name Description
user_impersonation representar sua conta de usuário

Exemplos

Get instance view of a virtual machine from a VM scale set placed on a dedicated host group through automatic placement.

Sample Request

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myVirtualMachineScaleSet/virtualMachines/0/instanceView?api-version=2022-08-01

Sample Response

{
  "platformUpdateDomain": 0,
  "platformFaultDomain": 0,
  "rdpThumbPrint": null,
  "vmAgent": {
    "vmAgentVersion": "Unknown",
    "statuses": [
      {
        "code": "ProvisioningState/Unavailable",
        "level": "Warning",
        "displayStatus": "Not Ready",
        "message": "VM status blob is found but not yet populated.",
        "time": "2022-08-01T05:00:32+00:00"
      }
    ],
    "extensionHandlers": null
  },
  "disks": [
    {
      "name": "myOSDisk",
      "encryptionSettings": null,
      "statuses": [
        {
          "code": "ProvisioningState/succeeded",
          "level": "Info",
          "displayStatus": "Provisioning succeeded",
          "message": null,
          "time": "2022-08-01T04:58:58.0882815+00:00"
        }
      ]
    }
  ],
  "extensions": null,
  "assignedHost": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/hostGroups/myHostGroup/hosts/myHost",
  "bootDiagnostics": null,
  "statuses": [
    {
      "code": "ProvisioningState/succeeded",
      "level": "Info",
      "displayStatus": "Provisioning succeeded",
      "message": null,
      "time": "2020-06-05T04:59:58.1852966+00:00"
    },
    {
      "code": "PowerState/running",
      "level": "Info",
      "displayStatus": "VM running",
      "message": null,
      "time": null
    }
  ]
}

Definições

ApiError

Erro de API.

ApiErrorBase

Base de erros de API.

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 um Configurações de criptografia para um disco

DiskInstanceView

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

InnerError

Detalhes do erro interno.

InstanceViewStatus

Status da exibição da instância.

KeyVaultKeyReference

Descreve uma referência a Key Vault Key

KeyVaultSecretReference

Descreve uma referência ao segredo Key Vault

MaintenanceOperationResultCodeTypes

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

MaintenanceRedeployStatus

Status da Operação de Manutenção.

StatusLevelTypes

O código de nível.

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.

VirtualMachineScaleSetVMInstanceView

A exibição de instância de uma VM do conjunto de dimensionamento de máquinas virtuais.

ApiError

Erro de API.

Name Type Description
code
  • string

O código de erro.

details

Os detalhes do erro da API

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.

Name Type Description
code
  • string

O código de erro.

message
  • string

A mensagem de erro.

target
  • string

O destino do erro específico.

BootDiagnosticsInstanceView

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

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

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.

Name Type Description
error

Erro de API.

DiskEncryptionSettings

Descreve um Configurações de criptografia para um disco

Name Type Description
diskEncryptionKey

Especifica o local da chave de criptografia de disco, que é um segredo Key Vault.

enabled
  • boolean

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

keyEncryptionKey

Especifica o local da chave de criptografia de chave em Key Vault.

DiskInstanceView

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

Name Type Description
encryptionSettings

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

As informações de status do recurso.

InnerError

Detalhes do erro interno.

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

Name Type Description
code
  • string

O código do status.

displayStatus
  • string

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

level

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

Descreve uma referência a Key Vault Key

Name Type Description
keyUrl
  • string

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

sourceVault

A URL relativa do Key Vault que contém a chave.

KeyVaultSecretReference

Descreve uma referência ao segredo Key Vault

Name Type Description
secretUrl
  • string

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

sourceVault

A URL relativa do Key Vault que contém o segredo.

MaintenanceOperationResultCodeTypes

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

Name Type Description
MaintenanceAborted
  • string
MaintenanceCompleted
  • string
None
  • string
RetryLater
  • string

MaintenanceRedeployStatus

Status da Operação de Manutenção.

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

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

maintenanceWindowEndTime
  • string

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

maintenanceWindowStartTime
  • string

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

preMaintenanceWindowEndTime
  • string

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

preMaintenanceWindowStartTime
  • string

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

StatusLevelTypes

O código de nível.

Name Type Description
Error
  • string
Info
  • string
Warning
  • string

SubResource

Name Type Description
id
  • string

ID do recurso

VirtualMachineAgentInstanceView

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

Name Type Description
extensionHandlers

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

statuses

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.

Name Type Description
status

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.

Name Type Description
name
  • string

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

statuses

As informações de status do recurso.

substatuses

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 Type Description
status

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

VirtualMachineScaleSetVMInstanceView

A exibição de instância de uma VM do conjunto de dimensionamento de máquinas virtuais.

Name Type Description
assignedHost
  • string

ID de recurso do host dedicado, no qual a máquina virtual é alocada por meio de posicionamento automático, quando a máquina virtual está associada a um grupo de hosts dedicado que tem o posicionamento automático habilitado.

Versão mínima da aPI: 2020-06-01.

bootDiagnostics

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 do hipervisor.

disks

As informações dos discos.

extensions

As informações de extensões.

maintenanceRedeployStatus

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

placementGroupId
  • string

O grupo de posicionamento no qual a VM está em execução. Se a VM for desalocada, ela não terá um placementGroupId.

platformFaultDomain
  • integer

A contagem de domínio de falha.

platformUpdateDomain
  • integer

A contagem de domínio de atualização.

rdpThumbPrint
  • string

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

statuses

As informações de status do recurso.

vmAgent

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

vmHealth

O status de integridade da VM.