Virtual Machine Scale Set VMs - Get Instance View

Servicio:

Compute

Versión de la API:

2024-07-01

Obtiene el estado de una máquina virtual de un conjunto de escalado de máquinas virtuales.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
instanceId	path	True	string	Identificador de instancia de la máquina virtual.
resourceGroupName	path	True	string	Nombre del grupo de recursos.
subscriptionId	path	True	string	Credenciales de suscripción que identifican de forma única la suscripción de Microsoft Azure. El identificador de suscripción forma parte del URI de cada llamada de servicio.
vmScaleSetName	path	True	string	Nombre del conjunto de escalado de máquinas virtuales.
api-version	query	True	string	Versión de api de cliente.

Respuestas

Nombre	Tipo	Description
200 OK	VirtualMachineScaleSetVMInstanceView	De acuerdo
Other Status Codes	CloudError	Respuesta de error que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

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

Solicitud de ejemplo

HTTP

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

Java

/**
 * 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

Python

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

Go

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

JavaScript

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

dotnet

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

Respuesta de muestra

status code:

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
    }
  ]
}

Definiciones

Nombre	Description
ApiError	Error de API.
ApiErrorBase	Base de errores de api.
BootDiagnosticsInstanceView	El diagnóstico de arranque es una característica de depuración que permite ver la salida de la consola y la captura de pantalla para diagnosticar el estado de la máquina virtual. Puede ver fácilmente la salida del registro de consola. Azure también le permite ver una captura de pantalla de la máquina virtual desde el hipervisor.
CloudError	Respuesta de error del servicio Compute.
DiskEncryptionSettings	Especifica la configuración de cifrado del disco del sistema operativo. Versión mínima de api: 2015-06-15
DiskInstanceView	La información de los discos.
HyperVGeneration	Generación del hipervisor de la máquina virtual [V1, V2]
InnerError	Detalles del error interno.
InstanceViewStatus	Estado de la vista de instancia.
KeyVaultKeyReference	Especifica la ubicación de la clave de cifrado de claves en Key Vault.
KeyVaultSecretReference	Especifica la ubicación de la clave de cifrado de disco, que es un secreto de Key Vault.
MaintenanceOperationResultCodeTypes	Código de resultado de la última operación de mantenimiento.
MaintenanceRedeployStatus	Estado de la operación de mantenimiento en la máquina virtual.
StatusLevelTypes	Código de nivel.
SubResource	Dirección URL relativa del almacén de claves que contiene el secreto.
VirtualMachineAgentInstanceView	Agente de máquina virtual que se ejecuta en la máquina virtual.
VirtualMachineExtensionHandlerInstanceView	Vista de instancia del controlador de extensión de máquina virtual.
VirtualMachineExtensionInstanceView	La información de extensiones.
VirtualMachineHealthStatus	Estado de mantenimiento de la máquina virtual.
VirtualMachineScaleSetVMInstanceView	Vista de instancia de una máquina virtual de conjunto de escalado de máquinas virtuales.

ApiError

Error de API.

Nombre	Tipo	Description
code	string	Código de error.
details	ApiErrorBase[]	Detalles del error de api
innererror	InnerError	Error interno de api
message	string	Mensaje de error.
target	string	Destino del error concreto.

ApiErrorBase

Base de errores de api.

Nombre	Tipo	Description
code	string	Código de error.
message	string	Mensaje de error.
target	string	Destino del error concreto.

BootDiagnosticsInstanceView

El diagnóstico de arranque es una característica de depuración que permite ver la salida de la consola y la captura de pantalla para diagnosticar el estado de la máquina virtual. Puede ver fácilmente la salida del registro de consola. Azure también le permite ver una captura de pantalla de la máquina virtual desde el hipervisor.

Nombre	Tipo	Description
consoleScreenshotBlobUri	string	El URI del blob de la consola. Nota: Esto no establecer si el diagnóstico de arranque está habilitado actualmente con almacenamiento administrado.
serialConsoleLogBlobUri	string	Uri del blob de registro de la consola serie. Nota: Esto no establecer si el diagnóstico de arranque está habilitado actualmente con almacenamiento administrado.
status	InstanceViewStatus	La información de estado de diagnóstico de arranque de la máquina virtual. Nota: Solo se establecerá si se producen errores al habilitar los diagnósticos de arranque.

CloudError

Respuesta de error del servicio Compute.

Nombre	Tipo	Description
error	ApiError	Error de API.

DiskEncryptionSettings

Especifica la configuración de cifrado del disco del sistema operativo.

Versión mínima de api: 2015-06-15

Nombre	Tipo	Description
diskEncryptionKey	KeyVaultSecretReference	Especifica la ubicación de la clave de cifrado de disco, que es un secreto de Key Vault.
enabled	boolean	Especifica si se debe habilitar el cifrado de disco en la máquina virtual.
keyEncryptionKey	KeyVaultKeyReference	Especifica la ubicación de la clave de cifrado de claves en Key Vault.

DiskInstanceView

La información de los discos.

Nombre	Tipo	Description
encryptionSettings	DiskEncryptionSettings[]	Especifica la configuración de cifrado del disco del sistema operativo. Versión mínima de api: 2015-06-15
name	string	Nombre del disco.
statuses	InstanceViewStatus[]	Información de estado del recurso.

HyperVGeneration

Generación del hipervisor de la máquina virtual [V1, V2]

Nombre	Tipo	Description
V1	string
V2	string

InnerError

Detalles del error interno.

Nombre	Tipo	Description
errordetail	string	Mensaje de error interno o volcado de memoria de excepciones.
exceptiontype	string	Tipo de excepción.

InstanceViewStatus

Estado de la vista de instancia.

Nombre	Tipo	Description
code	string	Código de estado.
displayStatus	string	Etiqueta localizable corta para el estado.
level	StatusLevelTypes	Código de nivel.
message	string	Mensaje de estado detallado, incluido para alertas y mensajes de error.
time	string	Hora del estado.

KeyVaultKeyReference

Especifica la ubicación de la clave de cifrado de claves en Key Vault.

Nombre	Tipo	Description
keyUrl	string	Dirección URL que hace referencia a una clave de cifrado de claves en Key Vault.
sourceVault	SubResource	Dirección URL relativa del almacén de claves que contiene la clave.

KeyVaultSecretReference

Especifica la ubicación de la clave de cifrado de disco, que es un secreto de Key Vault.

Nombre	Tipo	Description
secretUrl	string	Dirección URL que hace referencia a un secreto en un almacén de claves.
sourceVault	SubResource	Dirección URL relativa del almacén de claves que contiene el secreto.

MaintenanceOperationResultCodeTypes

Código de resultado de la última operación de mantenimiento.

Nombre	Tipo	Description
MaintenanceAborted	string
MaintenanceCompleted	string
None	string
RetryLater	string

MaintenanceRedeployStatus

Estado de la operación de mantenimiento en la máquina virtual.

Nombre	Tipo	Description
isCustomerInitiatedMaintenanceAllowed	boolean	True, si el cliente puede realizar el mantenimiento.
lastOperationMessage	string	Mensaje devuelto para la última operación de mantenimiento.
lastOperationResultCode	MaintenanceOperationResultCodeTypes	Código de resultado de la última operación de mantenimiento.
maintenanceWindowEndTime	string	Hora de finalización de la ventana de mantenimiento.
maintenanceWindowStartTime	string	Hora de inicio de la ventana de mantenimiento.
preMaintenanceWindowEndTime	string	Hora de finalización de la ventana de mantenimiento previo.
preMaintenanceWindowStartTime	string	Hora de inicio de la ventana de mantenimiento previo.

StatusLevelTypes

Código de nivel.

Nombre	Tipo	Description
Error	string
Info	string
Warning	string

SubResource

Dirección URL relativa del almacén de claves que contiene el secreto.

Nombre	Tipo	Description
id	string	Identificador de recurso

VirtualMachineAgentInstanceView

Agente de máquina virtual que se ejecuta en la máquina virtual.

Nombre	Tipo	Description
extensionHandlers	VirtualMachineExtensionHandlerInstanceView[]	Vista de instancia del controlador de extensión de máquina virtual.
statuses	InstanceViewStatus[]	Información de estado del recurso.
vmAgentVersion	string	Versión completa del agente de máquina virtual.

VirtualMachineExtensionHandlerInstanceView

Vista de instancia del controlador de extensión de máquina virtual.

Nombre	Tipo	Description
status	InstanceViewStatus	Estado del controlador de extensión.
type	string	Especifica el tipo de la extensión; Un ejemplo es "CustomScriptExtension".
typeHandlerVersion	string	Especifica la versión del controlador de script.

VirtualMachineExtensionInstanceView

La información de extensiones.

Nombre	Tipo	Description
name	string	Nombre de la extensión de máquina virtual.
statuses	InstanceViewStatus[]	Información de estado del recurso.
substatuses	InstanceViewStatus[]	Información de estado del recurso.
type	string	Especifica el tipo de la extensión; Un ejemplo es "CustomScriptExtension".
typeHandlerVersion	string	Especifica la versión del controlador de script.

VirtualMachineHealthStatus

Estado de mantenimiento de la máquina virtual.

Nombre	Tipo	Description
status	InstanceViewStatus	Información de estado de mantenimiento de la máquina virtual.

VirtualMachineScaleSetVMInstanceView

Vista de instancia de una máquina virtual de conjunto de escalado de máquinas virtuales.

Nombre	Tipo	Description
assignedHost	string	Identificador de recurso del host dedicado, en el que se asigna la máquina virtual a través de la colocación automática, cuando la máquina virtual está asociada a un grupo host dedicado que tiene habilitada la selección de ubicación automática. Versión mínima de api: 2020-06-01.
bootDiagnostics	BootDiagnosticsInstanceView	El diagnóstico de arranque es una característica de depuración que permite ver la salida de la consola y la captura de pantalla para diagnosticar el estado de la máquina virtual. Puede ver fácilmente la salida del registro de consola. Azure también le permite ver una captura de pantalla de la máquina virtual desde el hipervisor.
computerName	string	Especifica el nombre del sistema operativo host de la máquina virtual. Este nombre no se puede actualizar después de crear la máquina virtual. longitud máxima (Windows): 15 caracteres longitud máxima (Linux): 64 caracteres. Para conocer las convenciones de nomenclatura y las restricciones, consulte directrices de implementación de servicios de infraestructura de Azure.
disks	DiskInstanceView[]	La información de los discos.
extensions	VirtualMachineExtensionInstanceView[]	La información de extensiones.
hyperVGeneration	HyperVGeneration	Generación del hipervisor de la máquina virtual [V1, V2]
maintenanceRedeployStatus	MaintenanceRedeployStatus	Estado de la operación de mantenimiento en la máquina virtual.
osName	string	Sistema operativo que se ejecuta en la máquina híbrida.
osVersion	string	La versión del sistema operativo que se ejecuta en la máquina híbrida.
placementGroupId	string	Grupo de selección de ubicación en el que se ejecuta la máquina virtual. Si la máquina virtual está desasignada, no tendrá un placementGroupId.
platformFaultDomain	integer	Recuento de dominios de error.
platformUpdateDomain	integer	Recuento de dominios de actualización.
rdpThumbPrint	string	Huella digital del certificado de Escritorio remoto.
statuses	InstanceViewStatus[]	Información de estado del recurso.
vmAgent	VirtualMachineAgentInstanceView	Agente de máquina virtual que se ejecuta en la máquina virtual.
vmHealth	VirtualMachineHealthStatus	Estado de mantenimiento de la máquina virtual.