Virtual Machine Scale Set Extensions - List

Service:

Compute

API Version:

2024-03-01

Obtiene una lista de todas las extensiones de un conjunto de escalado de máquinas virtuales.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/extensions?api-version=2024-03-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 para cada llamada al servicio.
vmScaleSetName	path	True	string	Nombre del conjunto de escalado de máquinas virtuales que contiene la extensión.
api-version	query	True	string	Versión de api de cliente.

Respuestas

Nombre	Tipo	Description
200 OK	VirtualMachineScaleSetExtensionListResult	Aceptar
Other Status Codes	CloudError	Respuesta de error que describe el motivo del error de la operación.

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

VirtualMachineScaleSetExtension_List_MaximumSet_Gen

VirtualMachineScaleSetExtension_List_MinimumSet_Gen

VirtualMachineScaleSetExtension_List_MaximumSet_Gen

Sample Request

HTTP

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

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_extension_list_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_set_extensions.list(
        resource_group_name="rgcompute",
        vm_scale_set_name="aaaaaaaaaaaaaaaaaaaa",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtension_List_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

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/v5"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/92de53a5f1e0e03c94b40475d2135d97148ed014/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtension_List_MaximumSet_Gen.json
func ExampleVirtualMachineScaleSetExtensionsClient_NewListPager_virtualMachineScaleSetExtensionListMaximumSetGen() {
	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)
	}
	pager := clientFactory.NewVirtualMachineScaleSetExtensionsClient().NewListPager("rgcompute", "aaaaaaaaaaaaaaaaaaaa", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.VirtualMachineScaleSetExtensionListResult = armcompute.VirtualMachineScaleSetExtensionListResult{
		// 	Value: []*armcompute.VirtualMachineScaleSetExtension{
		// 		{
		// 			ID: to.Ptr("aaaaaaaa"),
		// 			Name: to.Ptr("{extension-name}"),
		// 			Type: to.Ptr("aaaaaaaaaaaaaaaaaaaaaaaa"),
		// 			Properties: &armcompute.VirtualMachineScaleSetExtensionProperties{
		// 				Type: to.Ptr("{extension-Type}"),
		// 				AutoUpgradeMinorVersion: to.Ptr(true),
		// 				EnableAutomaticUpgrade: to.Ptr(true),
		// 				ForceUpdateTag: to.Ptr("aaaaaaaaa"),
		// 				ProtectedSettings: map[string]any{
		// 				},
		// 				ProvisionAfterExtensions: []*string{
		// 					to.Ptr("aa")},
		// 					ProvisioningState: to.Ptr("Succeeded"),
		// 					Publisher: to.Ptr("{extension-Publisher}"),
		// 					Settings: map[string]any{
		// 					},
		// 					SuppressFailures: to.Ptr(true),
		// 					TypeHandlerVersion: to.Ptr("{handler-version}"),
		// 				},
		// 		}},
		// 	}
	}
}

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 a list of all extensions in a VM scale set.
 *
 * @summary Gets a list of all extensions in a VM scale set.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtension_List_MaximumSet_Gen.json
 */
async function virtualMachineScaleSetExtensionListMaximumSetGen() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["COMPUTE_RESOURCE_GROUP"] || "rgcompute";
  const vmScaleSetName = "aaaaaaaaaaaaaaaaaaaa";
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.virtualMachineScaleSetExtensions.list(
    resourceGroupName,
    vmScaleSetName,
  )) {
    resArray.push(item);
  }
  console.log(resArray);
}

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

Sample Response

Status code:

200

{
  "value": [
    {
      "name": "{extension-name}",
      "properties": {
        "autoUpgradeMinorVersion": true,
        "publisher": "{extension-Publisher}",
        "type": "{extension-Type}",
        "typeHandlerVersion": "{handler-version}",
        "settings": {},
        "forceUpdateTag": "aaaaaaaaa",
        "enableAutomaticUpgrade": true,
        "protectedSettings": {},
        "provisioningState": "aaa",
        "provisionAfterExtensions": [
          "aa"
        ],
        "suppressFailures": true
      },
      "type": "aaaaaaaaaaaaaaaaaaaaaaaa",
      "id": "aaaaaaaa"
    }
  ],
  "nextLink": "aa"
}

VirtualMachineScaleSetExtension_List_MinimumSet_Gen

Sample Request

HTTP

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

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_extension_list_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_set_extensions.list(
        resource_group_name="rgcompute",
        vm_scale_set_name="aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtension_List_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

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/v5"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/92de53a5f1e0e03c94b40475d2135d97148ed014/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtension_List_MinimumSet_Gen.json
func ExampleVirtualMachineScaleSetExtensionsClient_NewListPager_virtualMachineScaleSetExtensionListMinimumSetGen() {
	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)
	}
	pager := clientFactory.NewVirtualMachineScaleSetExtensionsClient().NewListPager("rgcompute", "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.VirtualMachineScaleSetExtensionListResult = armcompute.VirtualMachineScaleSetExtensionListResult{
		// 	Value: []*armcompute.VirtualMachineScaleSetExtension{
		// 		{
		// 	}},
		// }
	}
}

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 a list of all extensions in a VM scale set.
 *
 * @summary Gets a list of all extensions in a VM scale set.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtension_List_MinimumSet_Gen.json
 */
async function virtualMachineScaleSetExtensionListMinimumSetGen() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["COMPUTE_RESOURCE_GROUP"] || "rgcompute";
  const vmScaleSetName = "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa";
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.virtualMachineScaleSetExtensions.list(
    resourceGroupName,
    vmScaleSetName,
  )) {
    resArray.push(item);
  }
  console.log(resArray);
}

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

Sample Response

Status code:

200

{
  "value": [
    {}
  ]
}

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.
KeyVaultSecretReference	Describe una referencia al secreto de Key Vault
SubResource
VirtualMachineScaleSetExtension	Describe una extensión de conjunto de escalado de máquinas virtuales.
VirtualMachineScaleSetExtensionListResult	Respuesta de la operación enumerar la extensión 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	El mensaje de error.
target	string	Destino del error determinado.

ApiErrorBase

Base de errores de api.

Nombre	Tipo	Description
code	string	Código de error.
message	string	El mensaje de error.
target	string	Destino del error determinado.

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 la excepción.

KeyVaultSecretReference

Describe una referencia al secreto de Key Vault

Nombre	Tipo	Description
secretUrl	string	Dirección URL que hace referencia a un secreto en un Key Vault.
sourceVault	SubResource	Dirección URL relativa del Key Vault que contiene el secreto.

SubResource

Nombre	Tipo	Description
id	string	Id. de recurso

VirtualMachineScaleSetExtension

Describe una extensión de conjunto de escalado de máquinas virtuales.

Nombre	Tipo	Description
id	string	Id. de recurso
name	string	Nombre de la extensión.
properties.autoUpgradeMinorVersion	boolean	Indica si la extensión debe usar una versión secundaria más reciente si hay una disponible en el momento de la implementación. Sin embargo, una vez implementada, la extensión no actualizará las versiones secundarias a menos que se vuelva a implementar, incluso con esta propiedad establecida en true.
properties.enableAutomaticUpgrade	boolean	Indica si la plataforma debe actualizar automáticamente la extensión si hay una versión más reciente de la extensión disponible.
properties.forceUpdateTag	string	Si se proporciona un valor y es diferente del valor anterior, el controlador de extensión se verá obligado a actualizar aunque la configuración de la extensión no haya cambiado.
properties.protectedSettings	object	La extensión puede contener protectedSettings o protectedSettingsFromKeyVault o ninguna configuración protegida.
properties.protectedSettingsFromKeyVault	KeyVaultSecretReference	Configuración protegida de extensiones que se pasan por referencia y que se consumen desde el almacén de claves.
properties.provisionAfterExtensions	string[]	Colección de nombres de extensión después de los cuales se debe aprovisionar esta extensión.
properties.provisioningState	string	Estado de aprovisionamiento, que solo aparece en la respuesta.
properties.publisher	string	Nombre del publicador de controladores de extensión.
properties.settings	object	Configuración pública con formato JSON para la extensión.
properties.suppressFailures	boolean	Indica si los errores derivados de la extensión se suprimirán (los errores operativos, como no conectarse a la máquina virtual, no se suprimirán independientemente de este valor). El valor predeterminado es false.
properties.type	string	Especifica el tipo de la extensión; Un ejemplo es "CustomScriptExtension".
properties.typeHandlerVersion	string	Especifica la versión del controlador de script.
type	string	Tipo de recurso

VirtualMachineScaleSetExtensionListResult

Respuesta de la operación enumerar la extensión del conjunto de escalado de máquinas virtuales.

Nombre	Tipo	Description
nextLink	string	URI para capturar la página siguiente de las extensiones del conjunto de escalado de máquinas virtuales. Llame a ListNext() con esto para capturar la página siguiente de las extensiones del conjunto de escalado de máquinas virtuales.
value	VirtualMachineScaleSetExtension[]	Lista de extensiones del conjunto de escalado de máquinas virtuales.