Поделиться через


Virtual Machines - Instance View

Извлекает сведения о состоянии времени выполнения виртуальной машины.

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. Идентификатор подписки формирует часть URI для каждого вызова службы.

vmName
path True

string

Имя виртуальной машины.

api-version
query True

string

Версия API клиента.

Ответы

Имя Тип Описание
200 OK

VirtualMachineInstanceView

ОК

Other Status Codes

CloudError

Ответ об ошибке, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя Описание
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.

Образец запроса

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

Пример ответа

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

Образец запроса

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

Пример ответа

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

Диагностика загрузки — это функция отладки, которая позволяет просматривать выходные данные консоли и снимок экрана для диагностики состояния виртуальной машины. Вы можете легко просмотреть выходные данные журнала консоли. Azure также позволяет просмотреть снимок экрана виртуальной машины из низкоуровневой оболочки.

CloudError

Ответ об ошибке от службы вычислений.

DiskEncryptionSettings

Задает параметры шифрования для диска ОС.

Минимальная версия API: 15.06.2015

DiskInstanceView

Сведения о диске виртуальной машины.

HyperVGenerationType

Указывает тип HyperVGeneration, связанный с ресурсом.

InnerError

Сведения о внутренней ошибке.

InstanceViewStatus

Состояние представления экземпляра.

KeyVaultKeyReference

Указывает расположение ключа шифрования ключа в Key Vault.

KeyVaultSecretReference

Указывает расположение ключа шифрования диска, который является секретом Key Vault.

LastPatchInstallationSummary

Сводка по установке последней операции установки виртуальной машины.

MaintenanceOperationResultCodeTypes

Код результата последней операции обслуживания.

MaintenanceRedeployStatus

Состояние операции обслуживания на виртуальной машине.

PatchOperationStatus

Общий успех или состояние сбоя операции. Он остается "InProgress" до завершения операции. В этот момент он будет ознавать "Unknown", "Failed", "Succeeded" или "CompletedWithWarnings".

StatusLevelTypes

Код уровня.

SubResource

Относительный URL-адрес Key Vault, содержащего секрет.

VirtualMachineAgentInstanceView

Агент виртуальной машины, запущенный на виртуальной машине.

VirtualMachineExtensionHandlerInstanceView

Представление экземпляра обработчика расширения виртуальной машины.

VirtualMachineExtensionInstanceView

Сведения о расширениях.

VirtualMachineHealthStatus

Состояние работоспособности виртуальной машины.

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

Идентификатор действия операции, которая привела к этому результату. Он используется для сопоставления журналов CRP и расширений.

criticalAndSecurityPatchCount

integer

Количество критически важных исправлений или исправлений системы безопасности, которые были обнаружены как доступные и еще не установлены.

error

ApiError

Ошибки, возникшие во время выполнения операции. Массив сведений содержит их список.

lastModifiedTime

string

Метка времени в формате UTC при начале операции.

otherPatchCount

integer

Количество всех доступных исправлений, за исключением критически важных и безопасности.

rebootPending

boolean

Общее состояние перезагрузки виртуальной машины. Это значение будет true, если для частично установленных исправлений требуется перезагрузка для завершения установки, но перезагрузка еще не выполнена.

startTime

string

Метка времени в формате UTC при начале операции.

status

PatchOperationStatus

Общее состояние успешного или неудачного выполнения операции. Он остается "InProgress" до завершения операции. В этот момент он станет "Unknown", "Failed", "Succeeded" или "CompletedWithWarnings".

BootDiagnosticsInstanceView

Диагностика загрузки — это функция отладки, которая позволяет просматривать выходные данные консоли и снимок экрана для диагностики состояния виртуальной машины. Вы можете легко просмотреть выходные данные журнала консоли. Azure также позволяет просмотреть снимок экрана виртуальной машины из низкоуровневой оболочки.

Имя Тип Описание
consoleScreenshotBlobUri

string

URI большого двоичного объекта консоли. Примечание: Этот параметр не будет установлен, если загрузочный диагностика в настоящее время включен с управляемым хранилищем.

serialConsoleLogBlobUri

string

URI большого двоичного объекта последовательной консоли. Примечание: Этот параметр не будет установлен, если загрузочный диагностика в настоящее время включен с управляемым хранилищем.

status

InstanceViewStatus

Загрузочный диагностика сведения о состоянии виртуальной машины. Примечание: Он будет задан только в случае возникновения ошибок при включении диагностика загрузки.

CloudError

Ответ об ошибке от службы вычислений.

Имя Тип Описание
error

ApiError

Ошибка API.

DiskEncryptionSettings

Задает параметры шифрования для диска ОС.

Минимальная версия API: 15.06.2015

Имя Тип Описание
diskEncryptionKey

KeyVaultSecretReference

Указывает расположение ключа шифрования диска, который является секретом Key Vault.

enabled

boolean

Указывает, следует ли включить шифрование дисков на виртуальной машине.

keyEncryptionKey

KeyVaultKeyReference

Указывает расположение ключа шифрования ключа в Key Vault.

DiskInstanceView

Сведения о диске виртуальной машины.

Имя Тип Описание
encryptionSettings

DiskEncryptionSettings[]

Задает параметры шифрования для диска ОС.

Минимальная версия API: 15.06.2015

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

Указывает расположение ключа шифрования ключа в Key Vault.

Имя Тип Описание
keyUrl

string

URL-адрес, ссылающийся на ключ шифрования ключа в Key Vault.

sourceVault

SubResource

Относительный URL-адрес Key Vault, содержащего ключ.

KeyVaultSecretReference

Указывает расположение ключа шифрования диска, который является секретом Key Vault.

Имя Тип Описание
secretUrl

string

URL-адрес, ссылающийся на секрет в Key Vault.

sourceVault

SubResource

Относительный URL-адрес Key Vault, содержащего секрет.

LastPatchInstallationSummary

Сводка по установке последней операции установки виртуальной машины.

Имя Тип Описание
error

ApiError

Ошибки, возникшие во время выполнения операции. Массив сведений содержит их список.

excludedPatchCount

integer

Количество всех доступных исправлений, но явно исключенных указанным клиентом списком исключений.

failedPatchCount

integer

Количество исправлений, которые не удалось установить.

installationActivityId

string

Идентификатор действия операции, которая привела к этому результату. Он используется для сопоставления журналов 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

True, если клиенту разрешено выполнять обслуживание.

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-адрес Key Vault, содержащего секрет.

Имя Тип Описание
id

string

Идентификатор ресурса

VirtualMachineAgentInstanceView

Агент виртуальной машины, запущенный на виртуальной машине.

Имя Тип Описание
extensionHandlers

VirtualMachineExtensionHandlerInstanceView[]

Представление экземпляра обработчика расширения виртуальной машины.

statuses

InstanceViewStatus[]

Сведения о состоянии ресурса.

vmAgentVersion

string

Полная версия агента виртуальной машины.

VirtualMachineExtensionHandlerInstanceView

Представление экземпляра обработчика расширения виртуальной машины.

Имя Тип Описание
status

InstanceViewStatus

Состояние обработчика расширения.

type

string

Указывает тип расширения; пример : CustomScriptExtension.

typeHandlerVersion

string

Указывает версию обработчика скрипта.

VirtualMachineExtensionInstanceView

Сведения о расширениях.

Имя Тип Описание
name

string

Имя расширения виртуальной машины.

statuses

InstanceViewStatus[]

Сведения о состоянии ресурса.

substatuses

InstanceViewStatus[]

Сведения о состоянии ресурса.

type

string

Указывает тип расширения; пример : CustomScriptExtension.

typeHandlerVersion

string

Указывает версию обработчика скрипта.

VirtualMachineHealthStatus

Состояние работоспособности виртуальной машины.

Имя Тип Описание
status

InstanceViewStatus

Сведения о состоянии работоспособности виртуальной машины.

VirtualMachineInstanceView

Представление экземпляра виртуальной машины.

Имя Тип Описание
assignedHost

string

Идентификатор ресурса выделенного узла, на котором выделена виртуальная машина путем автоматического размещения, если виртуальная машина связана с выделенной группой узлов с включенным автоматическим размещением. Минимальная версия API: 2020-06-01.

bootDiagnostics

BootDiagnosticsInstanceView

Диагностика загрузки — это функция отладки, которая позволяет просматривать выходные данные консоли и снимок экрана для диагностики состояния виртуальной машины. Вы можете легко просмотреть выходные данные журнала консоли. Azure также позволяет просмотреть снимок экрана виртуальной машины из низкоуровневой оболочки.

computerName

string

Имя компьютера, назначенное виртуальной машине.

disks

DiskInstanceView[]

Сведения о диске виртуальной машины.

extensions

VirtualMachineExtensionInstanceView[]

Сведения о расширениях.

hyperVGeneration

HyperVGenerationType

Указывает тип HyperVGeneration, связанный с ресурсом.

isVMInStandbyPool

boolean

[Предварительная версия функции] Указывает, находится ли виртуальная машина в резервном пуле или из него.

maintenanceRedeployStatus

MaintenanceRedeployStatus

Состояние операции обслуживания на виртуальной машине.

osName

string

Операционная система, запущенная на виртуальной машине.

osVersion

string

Версия операционной системы, работающей на виртуальной машине.

patchStatus

VirtualMachinePatchStatus

[Предварительная версия функции] Состояние операций исправления виртуальной машины.

platformFaultDomain

integer

Задает домен сбоя виртуальной машины.

platformUpdateDomain

integer

Задает домен обновления виртуальной машины.

rdpThumbPrint

string

Отпечаток сертификата удаленного рабочего стола.

statuses

InstanceViewStatus[]

Сведения о состоянии ресурса.

vmAgent

VirtualMachineAgentInstanceView

Агент виртуальной машины, запущенный на виртуальной машине.

vmHealth

VirtualMachineHealthStatus

Состояние работоспособности виртуальной машины.

VirtualMachinePatchStatus

[Предварительная версия функции] Состояние операций исправления виртуальной машины.

Имя Тип Описание
availablePatchSummary

AvailablePatchSummary

Сводка доступных исправлений последней операции оценки для виртуальной машины.

configurationStatuses

InstanceViewStatus[]

Состояние включения указанного patchMode

lastPatchInstallationSummary

LastPatchInstallationSummary

Сводка по последней операции установки виртуальной машины.