Virtual Machine Scale Set VM Extensions - Create Or Update

Servizio:

Compute

Versione API:

2024-07-01

Operazione per creare o aggiornare l'estensione vm VMSS.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
instanceId	path	True	string	ID istanza della macchina virtuale.
resourceGroupName	path	True	string	Nome del gruppo di risorse.
subscriptionId	path	True	string	Credenziali di sottoscrizione che identificano in modo univoco la sottoscrizione di Microsoft Azure. L'ID sottoscrizione fa parte dell'URI per ogni chiamata al servizio.
vmExtensionName	path	True	string	Nome dell'estensione macchina virtuale.
vmScaleSetName	path	True	string	Nome del set di scalabilità di macchine virtuali.
api-version	query	True	string	Versione dell'API client.

Corpo della richiesta

Nome	Tipo	Descrizione
location	string	Posizione dell'estensione.
properties.autoUpgradeMinorVersion	boolean	Indica se l'estensione deve usare una versione secondaria più recente, se disponibile in fase di distribuzione. Dopo la distribuzione, tuttavia, l'estensione non aggiornerà le versioni secondarie a meno che non venga ridistribuibile, anche con questa proprietà impostata su true.
properties.enableAutomaticUpgrade	boolean	Indica se l'estensione deve essere aggiornata automaticamente dalla piattaforma se è disponibile una versione più recente dell'estensione.
properties.forceUpdateTag	string	Come deve essere forzato l'aggiornamento del gestore di estensioni anche se la configurazione dell'estensione non è stata modificata.
properties.instanceView	VirtualMachineExtensionInstanceView	Visualizzazione dell'istanza dell'estensione della macchina virtuale.
properties.protectedSettings	object	L'estensione può contenere protectedSettings o protectedSettingsFromKeyVault o nessuna impostazione protetta.
properties.protectedSettingsFromKeyVault	KeyVaultSecretReference	Impostazioni protette delle estensioni passate per riferimento e utilizzate dall'insieme di credenziali delle chiavi
properties.provisionAfterExtensions	string[]	Raccolta di nomi di estensione dopo i quali è necessario effettuare il provisioning di questa estensione.
properties.publisher	string	Nome del server di pubblicazione del gestore dell'estensione.
properties.settings	object	Impostazioni pubbliche in formato JSON per l'estensione.
properties.suppressFailures	boolean	Indica se gli errori derivanti dall'estensione verranno eliminati (gli errori operativi, ad esempio la mancata connessione alla macchina virtuale, non verranno eliminati indipendentemente da questo valore). Il valore predefinito è false.
properties.type	string	Specifica il tipo di estensione; un esempio è "CustomScriptExtension".
properties.typeHandlerVersion	string	Specifica la versione del gestore di script.

Risposte

Nome	Tipo	Descrizione
200 OK	VirtualMachineScaleSetVMExtension	OK
201 Created	VirtualMachineScaleSetVMExtension	Creato
Other Status Codes	CloudError	Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

Create VirtualMachineScaleSet VM extension.

Esempio di richiesta

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/069a65e8a6d1a6c0c58d9a9d97610b7103b6e8a5/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");

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

Risposta di esempio

Codice di stato:

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

Codice di stato:

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

Definizioni

Nome	Descrizione
ApiError	Errore dell'API.
ApiErrorBase	Base degli errori api.
CloudError	Risposta di errore dal servizio di calcolo.
InnerError	Dettagli dell'errore interno.
InstanceViewStatus	Stato di visualizzazione dell'istanza.
KeyVaultSecretReference	Descrive un riferimento al segreto dell'insieme di credenziali delle chiavi
StatusLevelTypes	Codice a livello.
SubResource
VirtualMachineExtensionInstanceView	Visualizzazione dell'istanza di un'estensione macchina virtuale.
VirtualMachineScaleSetVMExtension	Descrive un'estensione vm VMSS.

ApiError

Errore dell'API.

Nome	Tipo	Descrizione
code	string	Codice di errore.
details	ApiErrorBase[]	Dettagli dell'errore dell'API
innererror	InnerError	Errore interno dell'API
message	string	Messaggio di errore.
target	string	Destinazione dell'errore specifico.

ApiErrorBase

Base degli errori api.

Nome	Tipo	Descrizione
code	string	Codice di errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore specifico.

CloudError

Risposta di errore dal servizio di calcolo.

Nome	Tipo	Descrizione
error	ApiError	Errore dell'API.

InnerError

Dettagli dell'errore interno.

Nome	Tipo	Descrizione
errordetail	string	Messaggio di errore interno o dump delle eccezioni.
exceptiontype	string	Tipo di eccezione.

InstanceViewStatus

Stato di visualizzazione dell'istanza.

Nome	Tipo	Descrizione
code	string	Codice di stato.
displayStatus	string	Etichetta localizzabile breve per lo stato.
level	StatusLevelTypes	Codice a livello.
message	string	Messaggio di stato dettagliato, inclusi gli avvisi e i messaggi di errore.
time	string	Ora dello stato.

KeyVaultSecretReference

Descrive un riferimento al segreto dell'insieme di credenziali delle chiavi

Nome	Tipo	Descrizione
secretUrl	string	URL che fa riferimento a un segreto in un insieme di credenziali delle chiavi.
sourceVault	SubResource	URL relativo dell'insieme di credenziali delle chiavi contenente il segreto.

StatusLevelTypes

Codice a livello.

Nome	Tipo	Descrizione
Error	string
Info	string
Warning	string

SubResource

Nome	Tipo	Descrizione
id	string	ID risorsa

VirtualMachineExtensionInstanceView

Visualizzazione dell'istanza di un'estensione macchina virtuale.

Nome	Tipo	Descrizione
name	string	Nome dell'estensione della macchina virtuale.
statuses	InstanceViewStatus[]	Informazioni sullo stato della risorsa.
substatuses	InstanceViewStatus[]	Informazioni sullo stato della risorsa.
type	string	Specifica il tipo di estensione; un esempio è "CustomScriptExtension".
typeHandlerVersion	string	Specifica la versione del gestore di script.

VirtualMachineScaleSetVMExtension

Descrive un'estensione vm VMSS.

Nome	Tipo	Descrizione
id	string	ID risorsa
location	string	Posizione dell'estensione.
name	string	Nome dell'estensione.
properties.autoUpgradeMinorVersion	boolean	Indica se l'estensione deve usare una versione secondaria più recente, se disponibile in fase di distribuzione. Dopo la distribuzione, tuttavia, l'estensione non aggiornerà le versioni secondarie a meno che non venga ridistribuibile, anche con questa proprietà impostata su true.
properties.enableAutomaticUpgrade	boolean	Indica se l'estensione deve essere aggiornata automaticamente dalla piattaforma se è disponibile una versione più recente dell'estensione.
properties.forceUpdateTag	string	Come deve essere forzato l'aggiornamento del gestore di estensioni anche se la configurazione dell'estensione non è stata modificata.
properties.instanceView	VirtualMachineExtensionInstanceView	Visualizzazione dell'istanza dell'estensione della macchina virtuale.
properties.protectedSettings	object	L'estensione può contenere protectedSettings o protectedSettingsFromKeyVault o nessuna impostazione protetta.
properties.protectedSettingsFromKeyVault	KeyVaultSecretReference	Impostazioni protette delle estensioni passate per riferimento e utilizzate dall'insieme di credenziali delle chiavi
properties.provisionAfterExtensions	string[]	Raccolta di nomi di estensione dopo i quali è necessario effettuare il provisioning di questa estensione.
properties.provisioningState	string	Stato di provisioning, visualizzato solo nella risposta.
properties.publisher	string	Nome del server di pubblicazione del gestore dell'estensione.
properties.settings	object	Impostazioni pubbliche in formato JSON per l'estensione.
properties.suppressFailures	boolean	Indica se gli errori derivanti dall'estensione verranno eliminati (gli errori operativi, ad esempio la mancata connessione alla macchina virtuale, non verranno eliminati indipendentemente da questo valore). Il valore predefinito è false.
properties.type	string	Specifica il tipo di estensione; un esempio è "CustomScriptExtension".
properties.typeHandlerVersion	string	Specifica la versione del gestore di script.
type	string	Tipo di risorsa