Virtual Machine Scale Set VM Extensions - List

Служба:

Compute

Версия API:

2025-04-01

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

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

С использованием необязательных параметров:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/extensions?api-version=2025-04-01&$expand={$expand}

Параметры URI

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

Ответы

Имя	Тип	Описание
200 OK	VirtualMachineScaleSetVMExtensionsListResult	Запрос выполнен успешно.
Other Status Codes	CloudError	Непредвиденное сообщение об ошибке.

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

azure_auth

Azure Active Directory OAuth2 Flow.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

List extensions in Vmss instance.

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

HTTP

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myvmScaleSet/virtualMachines/0/extensions?api-version=2025-04-01

Java

/**
 * Samples for VirtualMachineScaleSetVMExtensions List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/examples/
     * virtualMachineScaleSetExamples/VirtualMachineScaleSetVMExtension_List.json
     */
    /**
     * Sample code: List extensions in Vmss instance.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listExtensionsInVmssInstance(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().manager().serviceClient().getVirtualMachineScaleSetVMExtensions()
            .listWithResponse("myResourceGroup", "myvmScaleSet", "0", null, 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_extension_list.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_vm_extensions.list(
        resource_group_name="myResourceGroup",
        vm_scale_set_name="myvmScaleSet",
        instance_id="0",
    )
    print(response)


# x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMExtension_List.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/v7"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/ccea12be6cd5e64743499d46f7a9c8b60df52db1/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMExtension_List.json
func ExampleVirtualMachineScaleSetVMExtensionsClient_List() {
	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.NewVirtualMachineScaleSetVMExtensionsClient().List(ctx, "myResourceGroup", "myvmScaleSet", "0", &armcompute.VirtualMachineScaleSetVMExtensionsClientListOptions{Expand: 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.VirtualMachineScaleSetVMExtensionsListResult = armcompute.VirtualMachineScaleSetVMExtensionsListResult{
	// 	Value: []*armcompute.VirtualMachineScaleSetVMExtension{
	// 		{
	// 			ID: to.Ptr("/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myvmScaleSet/virtualMachines/0/extensions/myVMExtension"),
	// 			Name: to.Ptr("myVMExtension"),
	// 			Type: to.Ptr("Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions"),
	// 			Properties: &armcompute.VirtualMachineExtensionProperties{
	// 				Type: to.Ptr("extType"),
	// 				AutoUpgradeMinorVersion: to.Ptr(true),
	// 				ProvisioningState: to.Ptr("Succeeded"),
	// 				Publisher: to.Ptr("extPublisher"),
	// 				Settings: map[string]any{
	// 					"UserName": "xyz@microsoft.com",
	// 				},
	// 				TypeHandlerVersion: to.Ptr("1.2"),
	// 			},
	// 		},
	// 		{
	// 			ID: to.Ptr("/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myvmScaleSet/virtualMachines/0/extensions/myVMExtension1"),
	// 			Name: to.Ptr("myVMExtension1"),
	// 			Type: to.Ptr("Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions"),
	// 			Properties: &armcompute.VirtualMachineExtensionProperties{
	// 				Type: to.Ptr("extType1"),
	// 				AutoUpgradeMinorVersion: to.Ptr(true),
	// 				ProvisioningState: to.Ptr("Succeeded"),
	// 				Publisher: to.Ptr("extPublisher1"),
	// 				Settings: map[string]any{
	// 					"UserName": "xyz@microsoft.com",
	// 				},
	// 				TypeHandlerVersion: to.Ptr("1.0"),
	// 			},
	// 	}},
	// }
}

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");
require("dotenv/config");

/**
 * This sample demonstrates how to The operation to get all extensions of an instance in Virtual Machine Scaleset.
 *
 * @summary The operation to get all extensions of an instance in Virtual Machine Scaleset.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMExtension_List.json
 */
async function listExtensionsInVmssInstance() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["COMPUTE_RESOURCE_GROUP"] || "myResourceGroup";
  const vmScaleSetName = "myvmScaleSet";
  const instanceId = "0";
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.virtualMachineScaleSetVMExtensions.list(
    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;

// Generated from example definition: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMExtension_List.json
// this example is just showing the usage of "VirtualMachineScaleSetVMExtensions_List" 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 = "myvmScaleSet";
string instanceId = "0";
ResourceIdentifier virtualMachineScaleSetVmResourceId = VirtualMachineScaleSetVmResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, virtualMachineScaleSetName, instanceId);
VirtualMachineScaleSetVmResource virtualMachineScaleSetVm = client.GetVirtualMachineScaleSetVmResource(virtualMachineScaleSetVmResourceId);

// get the collection of this VirtualMachineScaleSetVmExtensionResource
VirtualMachineScaleSetVmExtensionCollection collection = virtualMachineScaleSetVm.GetVirtualMachineScaleSetVmExtensions();

// invoke the operation and iterate over the result
await foreach (VirtualMachineScaleSetVmExtensionResource item in collection.GetAllAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    VirtualMachineScaleSetVmExtensionData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine("Succeeded");

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

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

Код состояния:

200

{
  "value": [
    {
      "properties": {
        "autoUpgradeMinorVersion": true,
        "provisioningState": "Succeeded",
        "publisher": "extPublisher",
        "type": "extType",
        "typeHandlerVersion": "1.2",
        "settings": {
          "UserName": "xyz@microsoft.com"
        }
      },
      "name": "myVMExtension",
      "type": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions",
      "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myvmScaleSet/virtualMachines/0/extensions/myVMExtension"
    },
    {
      "properties": {
        "autoUpgradeMinorVersion": true,
        "provisioningState": "Succeeded",
        "publisher": "extPublisher1",
        "type": "extType1",
        "typeHandlerVersion": "1.0",
        "settings": {
          "UserName": "xyz@microsoft.com"
        }
      },
      "name": "myVMExtension1",
      "type": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions",
      "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myvmScaleSet/virtualMachines/0/extensions/myVMExtension1"
    }
  ]
}

Определения

Имя	Описание
ApiError	Ошибка API.
ApiErrorBase	База ошибок API.
CloudError	Ответ об ошибке от службы вычислений.
InnerError	Сведения о внутренней ошибке.
InstanceViewStatus	Состояние представления экземпляра.
KeyVaultSecretReference	Описание ссылки на секрет Key Vault
StatusLevelTypes	Код уровня.
SubResource
VirtualMachineExtensionInstanceView	Представление экземпляра расширения виртуальной машины.
VirtualMachineScaleSetVMExtension	Описание расширения виртуальной машины VMSS.
VirtualMachineScaleSetVMExtensionsListResult	Реакция на операцию Список расширений VMSS VMSS

ApiError

Объект

Ошибка API.

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

ApiErrorBase

Объект

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

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

CloudError

Объект

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

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

InnerError

Объект

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

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

InstanceViewStatus

Объект

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

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

KeyVaultSecretReference

Объект

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

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

StatusLevelTypes

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

Код уровня.

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

SubResource

Объект

Имя	Тип	Описание
id	string	Идентификатор ресурса

VirtualMachineExtensionInstanceView

Объект

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

Имя	Тип	Описание
name	string	Имя расширения виртуальной машины.
statuses	InstanceViewStatus[]	Сведения о состоянии ресурса.
substatuses	InstanceViewStatus[]	Сведения о состоянии ресурса.
type	string	Указывает тип расширения; примером является CustomScriptExtension.
typeHandlerVersion	string	Указывает версию обработчика скрипта.

VirtualMachineScaleSetVMExtension

Объект

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

Имя	Тип	Описание
id	string	Идентификатор ресурса
location	string	Расположение расширения.
name	string	Имя ресурса
properties.autoUpgradeMinorVersion	boolean	Указывает, следует ли использовать более новую дополнительную версию, если она доступна во время развертывания. Однако после развертывания расширение не будет обновлять дополнительные версии без повторного развертывания, даже если это свойство не имеет значения true.
properties.enableAutomaticUpgrade	boolean	Указывает, следует ли автоматически обновлять расширение платформой, если доступна более новая версия расширения.
properties.forceUpdateTag	string	Как обработчик расширений должен быть вынужден обновляться, даже если конфигурация расширения не изменилась.
properties.instanceView	VirtualMachineExtensionInstanceView	Представление экземпляра расширения виртуальной машины.
properties.protectedSettings		Расширение может содержать защищенные параметрыSettings или protectedSettingsFromKeyVault или не иметь защищенных параметров.
properties.protectedSettingsFromKeyVault	KeyVaultSecretReference	Защищенные расширения, передаваемые по ссылке, и используемые из хранилища ключей
properties.provisionAfterExtensions	string[]	Коллекция имен расширений, после которой необходимо подготовить это расширение.
properties.provisioningState	string	Состояние подготовки, которое отображается только в ответе.
properties.publisher	string	Имя издателя обработчика расширений.
properties.settings		Форматированные общедоступные параметры json для расширения.
properties.suppressFailures	boolean	Указывает, будут ли отключены сбои, возникающие из расширения (операционные сбои, такие как отсутствие подключения к виртуальной машине, не будут подавляться независимо от этого значения). Значение по умолчанию — false.
properties.type	string	Указывает тип расширения; примером является CustomScriptExtension.
properties.typeHandlerVersion	string	Указывает версию обработчика скрипта.
type	string	Тип ресурса

VirtualMachineScaleSetVMExtensionsListResult

Объект

Реакция на операцию Список расширений VMSS VMSS

Имя	Тип	Описание
value	VirtualMachineScaleSetVMExtension[]	Список расширений VMSS для виртуальных машин