Virtual Machine Scale Set VMs - Get Instance View

Ссылка

Служба:: Compute

Версия API:: 2024-07-01

Возвращает состояние виртуальной машины из масштабируемого набора виртуальных машин.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
instanceId	path	True	string	Идентификатор экземпляра виртуальной машины.
resourceGroupName	path	True	string	Имя группы ресурсов.
subscriptionId	path	True	string	Учетные данные подписки, которые однозначно определяют подписку Microsoft Azure. Идентификатор подписки входит в состав URI для каждого вызова службы.
vmScaleSetName	path	True	string	Имя масштабируемого набора виртуальных машин.
api-version	query	True	string	Версия клиентского API.

Ответы

Имя	Тип	Описание
200 OK	VirtualMachineScaleSetVMInstanceView	ХОРОШО
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 from a VM scale set placed on a dedicated host group through automatic placement.

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

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


/**
 * Samples for VirtualMachineScaleSetVMs GetInstanceView.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/
     * virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Get_InstanceViewAutoPlacedOnDedicatedHostGroup.json
     */
    /**
     * Sample code: Get instance view of a virtual machine from a VM scale set placed on a dedicated host group through
     * automatic placement.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        getInstanceViewOfAVirtualMachineFromAVMScaleSetPlacedOnADedicatedHostGroupThroughAutomaticPlacement(
            com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().manager().serviceClient().getVirtualMachineScaleSetVMs().getInstanceViewWithResponse(
            "myResourceGroup", "myVirtualMachineScaleSet", "0", com.azure.core.util.Context.NONE);
    }
}

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

from azure.identity import DefaultAzureCredential

from azure.mgmt.compute import ComputeManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-compute
# USAGE
    python virtual_machine_scale_set_vm_get_instance_view_auto_placed_on_dedicated_host_group.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ComputeManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="{subscription-id}",
    )

    response = client.virtual_machine_scale_set_vms.get_instance_view(
        resource_group_name="myResourceGroup",
        vm_scale_set_name="myVirtualMachineScaleSet",
        instance_id="0",
    )
    print(response)


# x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Get_InstanceViewAutoPlacedOnDedicatedHostGroup.json
if __name__ == "__main__":
    main()

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

package armcompute_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/compute/armcompute/v6"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/069a65e8a6d1a6c0c58d9a9d97610b7103b6e8a5/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Get_InstanceViewAutoPlacedOnDedicatedHostGroup.json
func ExampleVirtualMachineScaleSetVMsClient_GetInstanceView() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcompute.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewVirtualMachineScaleSetVMsClient().GetInstanceView(ctx, "myResourceGroup", "myVirtualMachineScaleSet", "0", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.VirtualMachineScaleSetVMInstanceView = armcompute.VirtualMachineScaleSetVMInstanceView{
	// 	AssignedHost: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/hostGroups/myHostGroup/hosts/myHost"),
	// 	Disks: []*armcompute.DiskInstanceView{
	// 		{
	// 			Name: to.Ptr("myOSDisk"),
	// 			Statuses: []*armcompute.InstanceViewStatus{
	// 				{
	// 					Code: to.Ptr("ProvisioningState/succeeded"),
	// 					DisplayStatus: to.Ptr("Provisioning succeeded"),
	// 					Level: to.Ptr(armcompute.StatusLevelTypesInfo),
	// 					Time: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2024-07-01T04:58:58.088Z"); return t}()),
	// 			}},
	// 	}},
	// 	PlatformFaultDomain: to.Ptr[int32](0),
	// 	PlatformUpdateDomain: to.Ptr[int32](0),
	// 	Statuses: []*armcompute.InstanceViewStatus{
	// 		{
	// 			Code: to.Ptr("ProvisioningState/succeeded"),
	// 			DisplayStatus: to.Ptr("Provisioning succeeded"),
	// 			Level: to.Ptr(armcompute.StatusLevelTypesInfo),
	// 			Time: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-06-05T04:59:58.185Z"); return t}()),
	// 		},
	// 		{
	// 			Code: to.Ptr("PowerState/running"),
	// 			DisplayStatus: to.Ptr("VM running"),
	// 			Level: to.Ptr(armcompute.StatusLevelTypesInfo),
	// 	}},
	// 	VMAgent: &armcompute.VirtualMachineAgentInstanceView{
	// 		Statuses: []*armcompute.InstanceViewStatus{
	// 			{
	// 				Code: to.Ptr("ProvisioningState/Unavailable"),
	// 				DisplayStatus: to.Ptr("Not Ready"),
	// 				Level: to.Ptr(armcompute.StatusLevelTypesWarning),
	// 				Message: to.Ptr("VM status blob is found but not yet populated."),
	// 				Time: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2024-07-01T05:00:32.000Z"); return t}()),
	// 		}},
	// 		VMAgentVersion: to.Ptr("Unknown"),
	// 	},
	// }
}

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

const { ComputeManagementClient } = require("@azure/arm-compute");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets the status of a virtual machine from a VM scale set.
 *
 * @summary Gets the status of a virtual machine from a VM scale set.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Get_InstanceViewAutoPlacedOnDedicatedHostGroup.json
 */
async function getInstanceViewOfAVirtualMachineFromAVMScaleSetPlacedOnADedicatedHostGroupThroughAutomaticPlacement() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["COMPUTE_RESOURCE_GROUP"] || "myResourceGroup";
  const vmScaleSetName = "myVirtualMachineScaleSet";
  const instanceId = "0";
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.virtualMachineScaleSetVMs.getInstanceView(
    resourceGroupName,
    vmScaleSetName,
    instanceId,
  );
  console.log(result);
}

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

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

// Generated from example definition: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Get_InstanceViewAutoPlacedOnDedicatedHostGroup.json
// this example is just showing the usage of "VirtualMachineScaleSetVMs_GetInstanceView" 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 VirtualMachineScaleSetVmResource created on azure
// for more information of creating VirtualMachineScaleSetVmResource, please refer to the document of VirtualMachineScaleSetVmResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "myResourceGroup";
string virtualMachineScaleSetName = "myVirtualMachineScaleSet";
string instanceId = "0";
ResourceIdentifier virtualMachineScaleSetVmResourceId = VirtualMachineScaleSetVmResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, virtualMachineScaleSetName, instanceId);
VirtualMachineScaleSetVmResource virtualMachineScaleSetVm = client.GetVirtualMachineScaleSetVmResource(virtualMachineScaleSetVmResourceId);

// invoke the operation
VirtualMachineScaleSetVmInstanceView result = await virtualMachineScaleSetVm.GetInstanceViewAsync();

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": 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": "2024-07-01T05:00:32+00:00"
      }
    ],
    "extensionHandlers": null
  },
  "disks": [
    {
      "name": "myOSDisk",
      "encryptionSettings": null,
      "statuses": [
        {
          "code": "ProvisioningState/succeeded",
          "level": "Info",
          "displayStatus": "Provisioning succeeded",
          "message": null,
          "time": "2024-07-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
    }
  ]
}

Определения

Имя	Описание
ApiError	Ошибка API.
ApiErrorBase	База ошибок API.
BootDiagnosticsInstanceView	Диагностика загрузки — это функция отладки, которая позволяет просматривать выходные данные консоли и снимок экрана для диагностики состояния виртуальной машины. Вы можете легко просмотреть выходные данные журнала консоли. Azure также позволяет просмотреть снимок экрана виртуальной машины из гипервизора.
CloudError	Ответ на ошибку из службы вычислений.
DiskEncryptionSettings	Задает параметры шифрования для диска ОС. Минимальная версия API: 2015-06-15
DiskInstanceView	Сведения о дисках.
HyperVGeneration	Создание гипервизора виртуальной машины [V1, V2]
InnerError	Сведения о внутренней ошибке.
InstanceViewStatus	Состояние представления экземпляра.
KeyVaultKeyReference	Указывает расположение ключа шифрования ключей в Key Vault.
KeyVaultSecretReference	Указывает расположение ключа шифрования диска, являющегося секретом Key Vault.
MaintenanceOperationResultCodeTypes	Код результата последней операции обслуживания.
MaintenanceRedeployStatus	Состояние операции обслуживания на виртуальной машине.
StatusLevelTypes	Код уровня.
SubResource	Относительный URL-адрес Хранилища ключей, содержащий секрет.
VirtualMachineAgentInstanceView	Агент виртуальной машины, работающий на виртуальной машине.
VirtualMachineExtensionHandlerInstanceView	Представление экземпляра обработчика расширений виртуальной машины.
VirtualMachineExtensionInstanceView	Сведения о расширениях.
VirtualMachineHealthStatus	Состояние работоспособности виртуальной машины.
VirtualMachineScaleSetVMInstanceView	Представление экземпляра виртуальной машины масштабируемого набора виртуальных машин.

ApiError

Ошибка API.

Имя	Тип	Описание
code	string	Код ошибки.
details	ApiErrorBase[]	Сведения об ошибке API
innererror	InnerError	Внутренняя ошибка API
message	string	Сообщение об ошибке.
target	string	Целевой объект конкретной ошибки.

ApiErrorBase

База ошибок API.

Имя	Тип	Описание
code	string	Код ошибки.
message	string	Сообщение об ошибке.
target	string	Целевой объект конкретной ошибки.

BootDiagnosticsInstanceView

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

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

CloudError

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

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

DiskEncryptionSettings

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

Минимальная версия API: 2015-06-15

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

DiskInstanceView

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

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

HyperVGeneration

Создание гипервизора виртуальной машины [V1, V2]

Имя	Тип	Описание
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-адрес Хранилища ключей, содержащий ключ.

KeyVaultSecretReference

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

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

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

StatusLevelTypes

Код уровня.

Имя	Тип	Описание
Error	string
Info	string
Warning	string

SubResource

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

Имя	Тип	Описание
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	Сведения о состоянии работоспособности виртуальной машины.

VirtualMachineScaleSetVMInstanceView

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

Имя	Тип	Описание
assignedHost	string	Идентификатор ресурса выделенного узла, на котором виртуальная машина выделяется с помощью автоматического размещения, когда виртуальная машина связана с выделенной группой узлов с включенным автоматическим размещением. Минимальная версия API: 2020-06-01.
bootDiagnostics	BootDiagnosticsInstanceView	Диагностика загрузки — это функция отладки, которая позволяет просматривать выходные данные консоли и снимок экрана для диагностики состояния виртуальной машины. Вы можете легко просмотреть выходные данные журнала консоли. Azure также позволяет просмотреть снимок экрана виртуальной машины из гипервизора.
computerName	string	Указывает имя ОС узла виртуальной машины. Это имя невозможно обновить после создания виртуальной машины. Максимальная длина (Windows): 15 символов Максимальная длина (Linux): 64 символов. Соглашения об именовании и ограничения см. в руководства по реализации служб инфраструктуры Azure.
disks	DiskInstanceView[]	Сведения о дисках.
extensions	VirtualMachineExtensionInstanceView[]	Сведения о расширениях.
hyperVGeneration	HyperVGeneration	Создание гипервизора виртуальной машины [V1, V2]
maintenanceRedeployStatus	MaintenanceRedeployStatus	Состояние операции обслуживания на виртуальной машине.
osName	string	Операционная система, запущенная на гибридном компьютере.
osVersion	string	Версия операционной системы, запущенной на гибридном компьютере.
placementGroupId	string	Группа размещения, в которой выполняется виртуальная машина. Если виртуальная машина освобождена, у нее не будет идентификатора placementGroupId.
platformFaultDomain	integer	Число доменов сбоя.
platformUpdateDomain	integer	Число доменов обновления.
rdpThumbPrint	string	Отпечаток сертификата удаленного рабочего стола.
statuses	InstanceViewStatus[]	Сведения о состоянии ресурса.
vmAgent	VirtualMachineAgentInstanceView	Агент виртуальной машины, работающий на виртуальной машине.
vmHealth	VirtualMachineHealthStatus	Состояние работоспособности виртуальной машины.