Virtual Machine Scale Sets - Get Instance View

Referencia

Servicio:: Compute

Versión de la API:: 2024-07-01

Obtiene el estado de una instancia de conjunto de escalado de máquinas virtuales.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
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	VirtualMachineScaleSetInstanceView	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

VirtualMachineScaleSet_GetInstanceView_MaximumSet_Gen

VirtualMachineScaleSet_GetInstanceView_MinimumSet_Gen

VirtualMachineScaleSet_GetInstanceView_MaximumSet_Gen

Solicitud de ejemplo

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


/**
 * Samples for VirtualMachineScaleSets GetInstanceView.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/
     * virtualMachineScaleSetExamples/VirtualMachineScaleSet_GetInstanceView_MaximumSet_Gen.json
     */
    /**
     * Sample code: VirtualMachineScaleSet_GetInstanceView_MaximumSet_Gen.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        virtualMachineScaleSetGetInstanceViewMaximumSetGen(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().manager().serviceClient().getVirtualMachineScaleSets()
            .getInstanceViewWithResponse("rgcompute", "aaaaaaaaaaaaaaa", 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_get_instance_view_maximum_set_gen.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_sets.get_instance_view(
        resource_group_name="rgcompute",
        vm_scale_set_name="aaaaaaaaaaaaaaa",
    )
    print(response)


# x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_GetInstanceView_MaximumSet_Gen.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/VirtualMachineScaleSet_GetInstanceView_MaximumSet_Gen.json
func ExampleVirtualMachineScaleSetsClient_GetInstanceView_virtualMachineScaleSetGetInstanceViewMaximumSetGen() {
	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.NewVirtualMachineScaleSetsClient().GetInstanceView(ctx, "rgcompute", "aaaaaaaaaaaaaaa", 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.VirtualMachineScaleSetInstanceView = armcompute.VirtualMachineScaleSetInstanceView{
	// 	OrchestrationServices: []*armcompute.OrchestrationServiceSummary{
	// 		{
	// 			ServiceName: to.Ptr(armcompute.OrchestrationServiceNamesAutomaticRepairs),
	// 			ServiceState: to.Ptr(armcompute.OrchestrationServiceStateNotRunning),
	// 	}},
	// 	Statuses: []*armcompute.InstanceViewStatus{
	// 		{
	// 			Code: to.Ptr("ProvisioningState/succeeded"),
	// 			DisplayStatus: to.Ptr("Provisioning succeeded"),
	// 			Level: to.Ptr(armcompute.StatusLevelTypesInfo),
	// 			Message: to.Ptr("aaaaaaaaaaaaaaaaaaaaaaa"),
	// 			Time: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-11-30T12:58:26.526Z"); return t}()),
	// 	}},
	// 	VirtualMachine: &armcompute.VirtualMachineScaleSetInstanceViewStatusesSummary{
	// 		StatusesSummary: []*armcompute.VirtualMachineStatusCodeCount{
	// 			{
	// 				Code: to.Ptr("aa"),
	// 				Count: to.Ptr[int32](21),
	// 		}},
	// 	},
	// 	Extensions: []*armcompute.VirtualMachineScaleSetVMExtensionsSummary{
	// 		{
	// 			Name: to.Ptr("aaaaaaaaaaa"),
	// 			StatusesSummary: []*armcompute.VirtualMachineStatusCodeCount{
	// 				{
	// 					Code: to.Ptr("aa"),
	// 					Count: to.Ptr[int32](21),
	// 			}},
	// 	}},
	// }
}

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 VM scale set instance.
 *
 * @summary Gets the status of a VM scale set instance.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_GetInstanceView_MaximumSet_Gen.json
 */
async function virtualMachineScaleSetGetInstanceViewMaximumSetGen() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["COMPUTE_RESOURCE_GROUP"] || "rgcompute";
  const vmScaleSetName = "aaaaaaaaaaaaaaa";
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.virtualMachineScaleSets.getInstanceView(
    resourceGroupName,
    vmScaleSetName,
  );
  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.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/VirtualMachineScaleSet_GetInstanceView_MaximumSet_Gen.json
// this example is just showing the usage of "VirtualMachineScaleSets_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 VirtualMachineScaleSetResource created on azure
// for more information of creating VirtualMachineScaleSetResource, please refer to the document of VirtualMachineScaleSetResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "rgcompute";
string virtualMachineScaleSetName = "aaaaaaaaaaaaaaa";
ResourceIdentifier virtualMachineScaleSetResourceId = VirtualMachineScaleSetResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, virtualMachineScaleSetName);
VirtualMachineScaleSetResource virtualMachineScaleSet = client.GetVirtualMachineScaleSetResource(virtualMachineScaleSetResourceId);

// invoke the operation
VirtualMachineScaleSetInstanceView result = await virtualMachineScaleSet.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

{
  "virtualMachine": {
    "statusesSummary": [
      {
        "code": "aa",
        "count": 21
      }
    ]
  },
  "extensions": [
    {
      "name": "aaaaaaaaaaa",
      "statusesSummary": [
        {
          "code": "aa",
          "count": 21
        }
      ]
    }
  ],
  "statuses": [
    {
      "code": "ProvisioningState/succeeded",
      "level": "Info",
      "displayStatus": "Provisioning succeeded",
      "message": "aaaaaaaaaaaaaaaaaaaaaaa",
      "time": "2021-11-30T12:58:26.526Z"
    }
  ],
  "orchestrationServices": [
    {
      "serviceName": "AutomaticRepairs",
      "serviceState": "NotRunning"
    }
  ]
}

VirtualMachineScaleSet_GetInstanceView_MinimumSet_Gen

Solicitud de ejemplo

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


/**
 * Samples for VirtualMachineScaleSets GetInstanceView.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/
     * virtualMachineScaleSetExamples/VirtualMachineScaleSet_GetInstanceView_MinimumSet_Gen.json
     */
    /**
     * Sample code: VirtualMachineScaleSet_GetInstanceView_MinimumSet_Gen.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        virtualMachineScaleSetGetInstanceViewMinimumSetGen(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().manager().serviceClient().getVirtualMachineScaleSets()
            .getInstanceViewWithResponse("rgcompute", "aaaaaaaaaaaaaaa", 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_get_instance_view_minimum_set_gen.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_sets.get_instance_view(
        resource_group_name="rgcompute",
        vm_scale_set_name="aaaaaaaaaaaaaaa",
    )
    print(response)


# x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_GetInstanceView_MinimumSet_Gen.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/VirtualMachineScaleSet_GetInstanceView_MinimumSet_Gen.json
func ExampleVirtualMachineScaleSetsClient_GetInstanceView_virtualMachineScaleSetGetInstanceViewMinimumSetGen() {
	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.NewVirtualMachineScaleSetsClient().GetInstanceView(ctx, "rgcompute", "aaaaaaaaaaaaaaa", 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.VirtualMachineScaleSetInstanceView = armcompute.VirtualMachineScaleSetInstanceView{
	// }
}

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 VM scale set instance.
 *
 * @summary Gets the status of a VM scale set instance.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_GetInstanceView_MinimumSet_Gen.json
 */
async function virtualMachineScaleSetGetInstanceViewMinimumSetGen() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["COMPUTE_RESOURCE_GROUP"] || "rgcompute";
  const vmScaleSetName = "aaaaaaaaaaaaaaa";
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.virtualMachineScaleSets.getInstanceView(
    resourceGroupName,
    vmScaleSetName,
  );
  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.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/VirtualMachineScaleSet_GetInstanceView_MinimumSet_Gen.json
// this example is just showing the usage of "VirtualMachineScaleSets_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 VirtualMachineScaleSetResource created on azure
// for more information of creating VirtualMachineScaleSetResource, please refer to the document of VirtualMachineScaleSetResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "rgcompute";
string virtualMachineScaleSetName = "aaaaaaaaaaaaaaa";
ResourceIdentifier virtualMachineScaleSetResourceId = VirtualMachineScaleSetResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, virtualMachineScaleSetName);
VirtualMachineScaleSetResource virtualMachineScaleSet = client.GetVirtualMachineScaleSetResource(virtualMachineScaleSetResourceId);

// invoke the operation
VirtualMachineScaleSetInstanceView result = await virtualMachineScaleSet.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

{}

Definiciones

Nombre	Description
ApiError	Error de API.
ApiErrorBase	Base de errores de api.
CloudError	Respuesta de error del servicio Compute.
InnerError	Detalles del error interno.
InstanceViewStatus	Estado de la vista de instancia.
OrchestrationServiceNames	Nombre del servicio.
OrchestrationServiceState	Estado actual del servicio.
OrchestrationServiceSummary	Resumen de un servicio de orquestación de un conjunto de escalado de máquinas virtuales.
StatusLevelTypes	Código de nivel.
VirtualMachineScaleSetInstanceView	Vista de instancia de un conjunto de escalado de máquinas virtuales.
VirtualMachineScaleSetInstanceViewStatusesSummary	Resumen de los estados de la vista de instancia de las máquinas virtuales de un conjunto de escalado de máquinas virtuales.
VirtualMachineScaleSetVMExtensionsSummary	Resumen de extensiones para máquinas virtuales de un conjunto de escalado de máquinas virtuales.
VirtualMachineStatusCodeCount	El código de estado y el recuento del resumen del estado de la vista de la vista del 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.

CloudError

Respuesta de error del servicio Compute.

Nombre	Tipo	Description
error	ApiError	Error de API.

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.

OrchestrationServiceNames

Nombre del servicio.

Nombre	Tipo	Description
AutomaticRepairs	string

OrchestrationServiceState

Estado actual del servicio.

Nombre	Tipo	Description
NotRunning	string
Running	string
Suspended	string

OrchestrationServiceSummary

Resumen de un servicio de orquestación de un conjunto de escalado de máquinas virtuales.

Nombre	Tipo	Description
serviceName	OrchestrationServiceNames	Nombre del servicio.
serviceState	OrchestrationServiceState	Estado actual del servicio.

StatusLevelTypes

Código de nivel.

Nombre	Tipo	Description
Error	string
Info	string
Warning	string

VirtualMachineScaleSetInstanceView

Vista de instancia de un conjunto de escalado de máquinas virtuales.

Nombre	Tipo	Description
extensions	VirtualMachineScaleSetVMExtensionsSummary[]	La información de extensiones.
orchestrationServices	OrchestrationServiceSummary[]	La información de los servicios de orquestación.
statuses	InstanceViewStatus[]	Información de estado del recurso.
virtualMachine	VirtualMachineScaleSetInstanceViewStatusesSummary	Resumen del estado de la vista de instancia del conjunto de escalado de máquinas virtuales.

VirtualMachineScaleSetInstanceViewStatusesSummary

Resumen de los estados de la vista de instancia de las máquinas virtuales de un conjunto de escalado de máquinas virtuales.

Nombre	Tipo	Description
statusesSummary	VirtualMachineStatusCodeCount[]	La información de extensiones.

VirtualMachineScaleSetVMExtensionsSummary

Resumen de extensiones para máquinas virtuales de un conjunto de escalado de máquinas virtuales.

Nombre	Tipo	Description
name	string	Nombre de la extensión.
statusesSummary	VirtualMachineStatusCodeCount[]	La información de extensiones.

VirtualMachineStatusCodeCount

El código de estado y el recuento del resumen del estado de la vista de la vista del conjunto de escalado de máquinas virtuales.

Nombre	Tipo	Description
code	string	Código de estado de la vista de instancia.
count	integer	Número de instancias que tienen un código de estado determinado.

Compartir a través de

Virtual Machine Scale Sets - Get Instance View

Parámetros de identificador URI

Respuestas

Seguridad

azure_auth

Ámbitos

Ejemplos

VirtualMachineScaleSet_GetInstanceView_MaximumSet_Gen

Solicitud de ejemplo

Respuesta de muestra

VirtualMachineScaleSet_GetInstanceView_MinimumSet_Gen

Solicitud de ejemplo

Respuesta de muestra

Definiciones

ApiError

ApiErrorBase

CloudError

InnerError

InstanceViewStatus

OrchestrationServiceNames

OrchestrationServiceState

OrchestrationServiceSummary

StatusLevelTypes

VirtualMachineScaleSetInstanceView

VirtualMachineScaleSetInstanceViewStatusesSummary

VirtualMachineScaleSetVMExtensionsSummary

VirtualMachineStatusCodeCount

Recursos adicionales