Virtual Machines - Instance View

Служба:: Compute

Версия API:: 2025-11-01

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

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Имя группы ресурсов. Имя регистронезависимо.
subscriptionId	path	True	string minLength: 1	Идентификатор целевой подписки.
vmName	path	True	string	Имя виртуальной машины.
api-version	query	True	string minLength: 1	Версия API, используемая для данной операции.

Ответы

Имя	Тип	Описание
200 OK	VirtualMachineInstanceView	Операция Azure успешно завершена.
Other Status Codes	CloudError	Непредвиденное сообщение об ошибке.

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

azure_auth

Azure Active Directory OAuth2 Flow.

Тип: 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=2025-11-01

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using System.Xml;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Compute.Models;
using Azure.ResourceManager.Compute;

// Generated from example definition: specification/compute/resource-manager/Microsoft.Compute/Compute/stable/2025-11-01/examples/virtualMachineExamples/VirtualMachine_Get_InstanceViewAutoPlacedOnDedicatedHostGroup.json
// this example is just showing the usage of "VirtualMachines_InstanceView" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this VirtualMachineResource created on azure
// for more information of creating VirtualMachineResource, please refer to the document of VirtualMachineResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "myResourceGroup";
string vmName = "myVM";
ResourceIdentifier virtualMachineResourceId = VirtualMachineResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, vmName);
VirtualMachineResource virtualMachine = client.GetVirtualMachineResource(virtualMachineResourceId);

// invoke the operation
VirtualMachineInstanceView result = await virtualMachine.InstanceViewAsync();

Console.WriteLine($"Succeeded: {result}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

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

Код состояния:: 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": "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.

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

HTTP
dotnet

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

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using System.Xml;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Compute.Models;
using Azure.ResourceManager.Compute;

// Generated from example definition: specification/compute/resource-manager/Microsoft.Compute/Compute/stable/2025-11-01/examples/virtualMachineExamples/VirtualMachine_Get_InstanceView.json
// this example is just showing the usage of "VirtualMachines_InstanceView" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this VirtualMachineResource created on azure
// for more information of creating VirtualMachineResource, please refer to the document of VirtualMachineResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "myResourceGroup";
string vmName = "myVM";
ResourceIdentifier virtualMachineResourceId = VirtualMachineResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, vmName);
VirtualMachineResource virtualMachine = client.GetVirtualMachineResource(virtualMachineResourceId);

// invoke the operation
VirtualMachineInstanceView result = await virtualMachine.InstanceViewAsync();

Console.WriteLine($"Succeeded: {result}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

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

Код состояния:: 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	Представление экземпляра диагностики загрузки виртуальной машины.
CloudError	Ответ на ошибку из службы вычислений.
DiskEncryptionSettings	Описание параметров шифрования диска
DiskInstanceView	Представление экземпляра диска.
HyperVGenerationType	Указывает тип HyperVGeneration, связанный с ресурсом
InnerError	Сведения о внутренней ошибке.
InstanceViewStatus	Состояние представления экземпляра.
KeyVaultKeyReference	Описывает ссылку на Key Vault Key
KeyVaultSecretReference	Описывает отсылку к Key Vault Secret
LastPatchInstallationSummary	Описывает свойства последней установленной сводки исправлений.
MaintenanceOperationResultCodeTypes	Код результата последней операции обслуживания.
MaintenanceRedeployStatus	Состояние операции обслуживания.
PatchOperationStatus	Общее состояние успешного выполнения или сбоя операции. Он остается "InProgress" до завершения операции. На этом этапе она станет "Неизвестно", "Сбой", "Успешно" или "CompletedWithWarnings".
StatusLevelTypes	Код уровня.
StorageAlignmentStatus	Задаёт статус выравнивания памяти для диска.
SubResource
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	Идентификатор действия операции, создающей этот результат. Он используется для корреляции между журналами БЕЗОПАСНОСТИ и расширений.
criticalAndSecurityPatchCount	integer (int32)	Количество критически важных или исправлений безопасности, обнаруженных как доступные и еще не установленные.
error	ApiError	Ошибки, возникшие во время выполнения операции. Массив сведений содержит список из них.
lastModifiedTime	string (date-time)	Метка времени UTC при начале операции.
otherPatchCount	integer (int32)	Количество всех доступных исправлений, за исключением критически важных и безопасности.
rebootPending	boolean	Общее состояние перезагрузки виртуальной машины. Это будет верно, если частично установленные исправления требуют перезагрузки для завершения установки, но перезагрузка еще не произошла.
startTime	string (date-time)	Метка времени UTC при начале операции.
status	PatchOperationStatus	Общее состояние успешного выполнения или сбоя операции. Он остается "InProgress" до завершения операции. На этом этапе она станет "Неизвестно", "Сбой", "Успешно" или "CompletedWithWarnings".

BootDiagnosticsInstanceView

Объект

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

Имя	Тип	Описание
consoleScreenshotBlobUri	string	URI большого двоичного объекта консоли. Примечание. это не задаваться, если диагностика загрузки в настоящее время включена с управляемым хранилищем.
serialConsoleLogBlobUri	string	Универсальный код ресурса (URI) URI для последовательной консоли консоли. Примечание. это не задаваться, если диагностика загрузки в настоящее время включена с управляемым хранилищем.
status	InstanceViewStatus	Сведения о состоянии диагностики загрузки для виртуальной машины. Примечание. Он будет задан только в том случае, если возникают ошибки при включении диагностики загрузки.

CloudError

Объект

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

Имя	Тип	Описание
error	ApiError	Ошибка API.

DiskEncryptionSettings

Объект

Описание параметров шифрования диска

Имя	Тип	Описание
diskEncryptionKey	KeyVaultSecretReference	Указывает местоположение ключа шифрования диска, который является Key Vault Secret.
enabled	boolean	Указывает, следует ли включить шифрование дисков на виртуальной машине.
keyEncryptionKey	KeyVaultKeyReference	Указывает местоположение ключа шифрования ключа в Key Vault.

DiskInstanceView

Объект

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

Имя	Тип	Описание
encryptionSettings	DiskEncryptionSettings[]	Задает параметры шифрования для диска ОС. Минимальная версия API: 2015-06-15
name	string	Имя диска.
statuses	InstanceViewStatus[]	Сведения о состоянии ресурса.
storageAlignmentStatus	StorageAlignmentStatus	Задаёт статус выравнивания памяти для диска.

HyperVGenerationType

Перечисление

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

Значение	Описание
V1
V2

InnerError

Объект

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

Имя	Тип	Описание
errordetail	string	Внутреннее сообщение об ошибке или дамп исключений.
exceptiontype	string	Тип исключения.

InstanceViewStatus

Объект

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

Имя	Тип	Описание
code	string	Код состояния.
displayStatus	string	Короткая локализуемая метка для состояния.
level	StatusLevelTypes	Код уровня.
message	string	Подробное сообщение о состоянии, в том числе для оповещений и сообщений об ошибках.
time	string (date-time)	Время состояния.

KeyVaultKeyReference

Объект

Описывает ссылку на Key Vault Key

Имя	Тип	Описание
keyUrl	string	URL, ссылающийся на ключ шифрования ключа в Key Vault.
sourceVault	SubResource	Относительный URL Key Vault, содержащего ключ.

KeyVaultSecretReference

Объект

Описывает отсылку к Key Vault Secret

Имя	Тип	Описание
secretUrl	string	URL ссылается на секрет в Key Vault.
sourceVault	SubResource	Относительный URL Key Vault, содержащий секрет.

LastPatchInstallationSummary

Объект

Описывает свойства последней установленной сводки исправлений.

Имя	Тип	Описание
error	ApiError	Ошибки, возникшие во время выполнения операции. Массив сведений содержит список из них.
excludedPatchCount	integer (int32)	Количество всех доступных исправлений, кроме явно исключенных списком исключений, заданным клиентом.
failedPatchCount	integer (int32)	Количество исправлений, которые не удалось установить.
installationActivityId	string	Идентификатор действия операции, создающей этот результат. Он используется для корреляции между журналами БЕЗОПАСНОСТИ и расширений.
installedPatchCount	integer (int32)	Количество исправлений, которые успешно установлены.
lastModifiedTime	string (date-time)	Метка времени UTC при начале операции.
maintenanceWindowExceeded	boolean	Описывает, истекло ли время операции до завершения всех предполагаемых действий.
notSelectedPatchCount	integer (int32)	Количество всех доступных исправлений, но не будет установлено, так как оно не соответствует записи списка классификации или включения.
pendingPatchCount	integer (int32)	Количество всех доступных исправлений, которые должны быть установлены в течение операции установки исправлений.
startTime	string (date-time)	Метка времени UTC при начале операции.
status	PatchOperationStatus	Общее состояние успешного выполнения или сбоя операции. Он остается "InProgress" до завершения операции. На этом этапе она станет "Неизвестно", "Сбой", "Успешно" или "CompletedWithWarnings".

MaintenanceOperationResultCodeTypes

Перечисление

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

Значение	Описание
None
RetryLater
MaintenanceAborted
MaintenanceCompleted

MaintenanceRedeployStatus

Объект

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

Имя	Тип	Описание
isCustomerInitiatedMaintenanceAllowed	boolean	Значение true, если клиенту разрешено выполнять обслуживание.
lastOperationMessage	string	Сообщение, возвращенное для последней операции обслуживания.
lastOperationResultCode	MaintenanceOperationResultCodeTypes	Код результата последней операции обслуживания.
maintenanceWindowEndTime	string (date-time)	Время окончания периода обслуживания.
maintenanceWindowStartTime	string (date-time)	Время начала периода обслуживания.
preMaintenanceWindowEndTime	string (date-time)	Время окончания периода предварительного обслуживания.
preMaintenanceWindowStartTime	string (date-time)	Время начала периода предварительного обслуживания.

PatchOperationStatus

Перечисление

Общее состояние успешного выполнения или сбоя операции. Он остается "InProgress" до завершения операции. На этом этапе она станет "Неизвестно", "Сбой", "Успешно" или "CompletedWithWarnings".

Значение	Описание
Unknown
InProgress
Failed
Succeeded
CompletedWithWarnings

StatusLevelTypes

Перечисление

Код уровня.

Значение	Описание
Info
Warning
Error

StorageAlignmentStatus

Перечисление

Задаёт статус выравнивания памяти для диска.

Значение	Описание
Unaligned	Диск не имеет домен неисправности хранения для вычисления отображения доменов ошибок. Один сбой в домене сбоя памяти может затронуть все виртуальные машины, ссылающиеся на этот профиль диска.
Aligned	Диск имеет домен неисправностей хранения для вычисления отображения доменов отказа. Сбой в домене неисправности хранения ограничен виртуальными машинами в одном домене вычислительной неисправности.

SubResource

Объект

Имя	Тип	Описание
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 (int32)	Указывает домен сбоя виртуальной машины.
platformUpdateDomain	integer (int32)	Указывает домен обновления виртуальной машины.
rdpThumbPrint	string	Отпечаток сертификата удаленного рабочего стола.
statuses	InstanceViewStatus[]	Сведения о состоянии ресурса.
vmAgent	VirtualMachineAgentInstanceView	Агент виртуальной машины, работающий на виртуальной машине.
vmHealth	VirtualMachineHealthStatus	Состояние работоспособности виртуальной машины.

VirtualMachinePatchStatus

Объект

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

Имя	Тип	Описание
availablePatchSummary	AvailablePatchSummary	Доступная сводка по исправлению последней операции оценки для виртуальной машины.
configurationStatuses	InstanceViewStatus[]	Состояние включения указанного patchMode
lastPatchInstallationSummary	LastPatchInstallationSummary	Сводка по установке последней операции установки для виртуальной машины.