Virtual Machine Scale Set VM Extensions - Create Or Update

Service:

Compute

Version d'API:

2024-07-01

Opération de création ou de mise à jour de l’extension de machine virtuelle VMSS.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
instanceId	path	True	string	ID d’instance de la machine virtuelle.
resourceGroupName	path	True	string	Nom du groupe de ressources.
subscriptionId	path	True	string	Informations d’identification d’abonnement qui identifient de manière unique l’abonnement Microsoft Azure. L’ID d’abonnement fait partie de l’URI de chaque appel de service.
vmExtensionName	path	True	string	Nom de l’extension de machine virtuelle.
vmScaleSetName	path	True	string	Nom du groupe de machines virtuelles identiques.
api-version	query	True	string	Version de l’API cliente.

Corps de la demande

Nom	Type	Description
location	string	Emplacement de l’extension.
properties.autoUpgradeMinorVersion	boolean	Indique si l’extension doit utiliser une version mineure plus récente si elle est disponible au moment du déploiement. Une fois déployée, toutefois, l’extension ne met pas à niveau les versions mineures, sauf si elle est redéployée, même avec cette propriété définie sur true.
properties.enableAutomaticUpgrade	boolean	Indique si l’extension doit être automatiquement mise à niveau par la plateforme s’il existe une version plus récente de l’extension disponible.
properties.forceUpdateTag	string	Comment le gestionnaire d’extensions doit être forcé de mettre à jour même si la configuration de l’extension n’a pas changé.
properties.instanceView	VirtualMachineExtensionInstanceView	Vue d’instance d’extension de machine virtuelle.
properties.protectedSettings	object	L’extension peut contenir protectedSettings ou protectedSettingsFromKeyVault ou aucun paramètre protégé du tout.
properties.protectedSettingsFromKeyVault	KeyVaultSecretReference	Paramètres protégés par extensions passés par référence et consommés à partir du coffre de clés
properties.provisionAfterExtensions	string[]	Collection de noms d’extensions après lesquels cette extension doit être provisionnée.
properties.publisher	string	Nom du serveur de publication du gestionnaire d’extensions.
properties.settings	object	Paramètres publics au format Json pour l’extension.
properties.suppressFailures	boolean	Indique si les échecs résultant de l’extension seront supprimés (les échecs opérationnels tels que la connexion à la machine virtuelle ne seront pas supprimés indépendamment de cette valeur). La valeur par défaut est false.
properties.type	string	Spécifie le type de l’extension ; un exemple est « CustomScriptExtension ».
properties.typeHandlerVersion	string	Spécifie la version du gestionnaire de scripts.

Réponses

Nom	Type	Description
200 OK	VirtualMachineScaleSetVMExtension	D’ACCORD
201 Created	VirtualMachineScaleSetVMExtension	Créé
Other Status Codes	CloudError	Réponse d’erreur décrivant pourquoi l’opération a échoué.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Exemples

Create VirtualMachineScaleSet VM extension.

Exemple de requête

HTTP

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

{
  "properties": {
    "autoUpgradeMinorVersion": true,
    "publisher": "extPublisher",
    "type": "extType",
    "typeHandlerVersion": "1.2",
    "settings": {
      "UserName": "xyz@microsoft.com"
    }
  }
}

Java

import com.azure.core.management.serializer.SerializerFactory;
import com.azure.core.util.serializer.SerializerEncoding;
import com.azure.resourcemanager.compute.fluent.models.VirtualMachineScaleSetVMExtensionInner;
import java.io.IOException;

/**
 * Samples for VirtualMachineScaleSetVMExtensions CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/
     * virtualMachineScaleSetExamples/VirtualMachineScaleSetVMExtension_Create.json
     */
    /**
     * Sample code: Create VirtualMachineScaleSet VM extension.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void createVirtualMachineScaleSetVMExtension(com.azure.resourcemanager.AzureResourceManager azure)
        throws IOException {
        azure.virtualMachines().manager().serviceClient().getVirtualMachineScaleSetVMExtensions().createOrUpdate(
            "myResourceGroup", "myvmScaleSet", "0", "myVMExtension",
            new VirtualMachineScaleSetVMExtensionInner().withPublisher("extPublisher").withTypePropertiesType("extType")
                .withTypeHandlerVersion("1.2").withAutoUpgradeMinorVersion(true)
                .withSettings(SerializerFactory.createDefaultManagementSerializerAdapter()
                    .deserialize("{\"UserName\":\"xyz@microsoft.com\"}", Object.class, SerializerEncoding.JSON)),
            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_create.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.begin_create_or_update(
        resource_group_name="myResourceGroup",
        vm_scale_set_name="myvmScaleSet",
        instance_id="0",
        vm_extension_name="myVMExtension",
        extension_parameters={
            "properties": {
                "autoUpgradeMinorVersion": True,
                "publisher": "extPublisher",
                "settings": {"UserName": "xyz@microsoft.com"},
                "type": "extType",
                "typeHandlerVersion": "1.2",
            }
        },
    ).result()
    print(response)


# x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMExtension_Create.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/azcore/to"
	"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/d6d0798c6f5eb196fba7bd1924db2b145a94f58c/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMExtension_Create.json
func ExampleVirtualMachineScaleSetVMExtensionsClient_BeginCreateOrUpdate() {
	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)
	}
	poller, err := clientFactory.NewVirtualMachineScaleSetVMExtensionsClient().BeginCreateOrUpdate(ctx, "myResourceGroup", "myvmScaleSet", "0", "myVMExtension", armcompute.VirtualMachineScaleSetVMExtension{
		Properties: &armcompute.VirtualMachineExtensionProperties{
			Type:                    to.Ptr("extType"),
			AutoUpgradeMinorVersion: to.Ptr(true),
			Publisher:               to.Ptr("extPublisher"),
			Settings: map[string]any{
				"UserName": "xyz@microsoft.com",
			},
			TypeHandlerVersion: to.Ptr("1.2"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %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.VirtualMachineScaleSetVMExtension = 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"),
	// 	},
	// }
}

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 create or update the VMSS VM extension.
 *
 * @summary The operation to create or update the VMSS VM extension.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMExtension_Create.json
 */
async function createVirtualMachineScaleSetVMExtension() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["COMPUTE_RESOURCE_GROUP"] || "myResourceGroup";
  const vmScaleSetName = "myvmScaleSet";
  const instanceId = "0";
  const vmExtensionName = "myVMExtension";
  const extensionParameters = {
    typePropertiesType: "extType",
    autoUpgradeMinorVersion: true,
    publisher: "extPublisher",
    settings: { UserName: "xyz@microsoft.com" },
    typeHandlerVersion: "1.2",
  };
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.virtualMachineScaleSetVMExtensions.beginCreateOrUpdateAndWait(
    resourceGroupName,
    vmScaleSetName,
    instanceId,
    vmExtensionName,
    extensionParameters,
  );
  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/2024-07-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMExtension_Create.json
// this example is just showing the usage of "VirtualMachineScaleSetVMExtensions_CreateOrUpdate" 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
string vmExtensionName = "myVMExtension";
VirtualMachineScaleSetVmExtensionData data = new VirtualMachineScaleSetVmExtensionData
{
    Publisher = "extPublisher",
    ExtensionType = "extType",
    TypeHandlerVersion = "1.2",
    AutoUpgradeMinorVersion = true,
    Settings = BinaryData.FromObjectAsJson(new
    {
        UserName = "xyz@microsoft.com",
    }),
};
ArmOperation<VirtualMachineScaleSetVmExtensionResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, vmExtensionName, data);
VirtualMachineScaleSetVmExtensionResource result = lro.Value;

// the variable result 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 = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

Exemple de réponse

Code d’état:

201

{
  "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": "Creating",
    "publisher": "extPublisher",
    "type": "extType",
    "typeHandlerVersion": "1.2",
    "settings": {
      "UserName": "xyz@microsoft.com"
    }
  }
}

Code d’état:

200

{
  "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": "Creating",
    "publisher": "extPublisher",
    "type": "extType",
    "typeHandlerVersion": "1.2",
    "settings": {
      "UserName": "xyz@microsoft.com"
    }
  }
}

Définitions

Nom	Description
ApiError	Erreur d’API.
ApiErrorBase	Base d’erreurs d’API.
CloudError	Réponse d’erreur du service de calcul.
InnerError	Détails de l’erreur interne.
InstanceViewStatus	État de l’affichage de l’instance.
KeyVaultSecretReference	Décrit une référence au secret Key Vault
StatusLevelTypes	Code de niveau.
SubResource
VirtualMachineExtensionInstanceView	Vue d’instance d’une extension de machine virtuelle.
VirtualMachineScaleSetVMExtension	Décrit une extension de machine virtuelle VMSS.

ApiError

Erreur d’API.

Nom	Type	Description
code	string	Code d’erreur.
details	ApiErrorBase[]	Détails de l’erreur api
innererror	InnerError	Erreur interne de l’API
message	string	Message d’erreur.
target	string	Cible de l’erreur particulière.

ApiErrorBase

Base d’erreurs d’API.

Nom	Type	Description
code	string	Code d’erreur.
message	string	Message d’erreur.
target	string	Cible de l’erreur particulière.

CloudError

Réponse d’erreur du service de calcul.

Nom	Type	Description
error	ApiError	Erreur d’API.

InnerError

Détails de l’erreur interne.

Nom	Type	Description
errordetail	string	Message d’erreur interne ou vidage d’exception.
exceptiontype	string	Type d’exception.

InstanceViewStatus

État de l’affichage de l’instance.

Nom	Type	Description
code	string	Code d’état.
displayStatus	string	Étiquette localisable courte pour l’état.
level	StatusLevelTypes	Code de niveau.
message	string	Message d’état détaillé, y compris pour les alertes et les messages d’erreur.
time	string	Heure de l’état.

KeyVaultSecretReference

Décrit une référence au secret Key Vault

Nom	Type	Description
secretUrl	string	URL référençant un secret dans un coffre de clés.
sourceVault	SubResource	URL relative du coffre de clés contenant le secret.

StatusLevelTypes

Code de niveau.

Nom	Type	Description
Error	string
Info	string
Warning	string

SubResource

Nom	Type	Description
id	string	ID de ressource

VirtualMachineExtensionInstanceView

Vue d’instance d’une extension de machine virtuelle.

Nom	Type	Description
name	string	Nom de l’extension de machine virtuelle.
statuses	InstanceViewStatus[]	Informations d’état de la ressource.
substatuses	InstanceViewStatus[]	Informations d’état de la ressource.
type	string	Spécifie le type de l’extension ; un exemple est « CustomScriptExtension ».
typeHandlerVersion	string	Spécifie la version du gestionnaire de scripts.

VirtualMachineScaleSetVMExtension

Décrit une extension de machine virtuelle VMSS.

Nom	Type	Description
id	string	ID de ressource
location	string	Emplacement de l’extension.
name	string	Nom de l’extension.
properties.autoUpgradeMinorVersion	boolean	Indique si l’extension doit utiliser une version mineure plus récente si elle est disponible au moment du déploiement. Une fois déployée, toutefois, l’extension ne met pas à niveau les versions mineures, sauf si elle est redéployée, même avec cette propriété définie sur true.
properties.enableAutomaticUpgrade	boolean	Indique si l’extension doit être automatiquement mise à niveau par la plateforme s’il existe une version plus récente de l’extension disponible.
properties.forceUpdateTag	string	Comment le gestionnaire d’extensions doit être forcé de mettre à jour même si la configuration de l’extension n’a pas changé.
properties.instanceView	VirtualMachineExtensionInstanceView	Vue d’instance d’extension de machine virtuelle.
properties.protectedSettings	object	L’extension peut contenir protectedSettings ou protectedSettingsFromKeyVault ou aucun paramètre protégé du tout.
properties.protectedSettingsFromKeyVault	KeyVaultSecretReference	Paramètres protégés par extensions passés par référence et consommés à partir du coffre de clés
properties.provisionAfterExtensions	string[]	Collection de noms d’extensions après lesquels cette extension doit être provisionnée.
properties.provisioningState	string	État d’approvisionnement, qui apparaît uniquement dans la réponse.
properties.publisher	string	Nom du serveur de publication du gestionnaire d’extensions.
properties.settings	object	Paramètres publics au format Json pour l’extension.
properties.suppressFailures	boolean	Indique si les échecs résultant de l’extension seront supprimés (les échecs opérationnels tels que la connexion à la machine virtuelle ne seront pas supprimés indépendamment de cette valeur). La valeur par défaut est false.
properties.type	string	Spécifie le type de l’extension ; un exemple est « CustomScriptExtension ».
properties.typeHandlerVersion	string	Spécifie la version du gestionnaire de scripts.
type	string	Type de ressource