Virtual Machine Scale Set VM Extensions - Update

Layanan:

Compute

Versi API:

2025-11-01

Operasi untuk memperbarui ekstensi VMSS VMS.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
instanceId	path	True	string	ID instans komputer virtual.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nama grup sumber daya. Nama tidak sensitif terhadap penggunaan huruf besar atau kecil.
subscriptionId	path	True	string minLength: 1	ID langganan target.
vmExtensionName	path	True	string	Nama ekstensi komputer virtual.
vmScaleSetName	path	True	string	Nama set skala VM.
api-version	query	True	string minLength: 1	Versi API yang digunakan untuk operasi ini.

Isi Permintaan

Nama	Jenis	Deskripsi
properties.autoUpgradeMinorVersion	boolean	Menunjukkan apakah ekstensi harus menggunakan versi minor yang lebih baru jika tersedia pada waktu penyebaran. Namun, setelah disebarkan, ekstensi tidak akan meningkatkan versi minor kecuali disebarkan ulang, bahkan dengan properti ini diatur ke true.
properties.enableAutomaticUpgrade	boolean	Menunjukkan apakah ekstensi harus ditingkatkan secara otomatis oleh platform jika ada versi ekstensi yang lebih baru yang tersedia.
properties.forceUpdateTag	string	Bagaimana handler ekstensi harus diperbarui meskipun konfigurasi ekstensi belum berubah.
properties.protectedSettings		Ekstensi dapat berisi protectedSettings atau protectedSettingsFromKeyVault atau tidak ada pengaturan yang dilindungi sama sekali.
properties.protectedSettingsFromKeyVault	KeyVaultSecretReference	Pengaturan yang dilindungi ekstensi yang diteruskan oleh referensi, dan dikonsumsi dari brankas kunci
properties.publisher	string	Nama penerbit handler ekstensi.
properties.settings		Pengaturan publik berformat Json untuk ekstensi.
properties.suppressFailures	boolean	Menunjukkan apakah kegagalan yang berasal dari ekstensi akan ditekan (Kegagalan operasional seperti tidak terhubung ke VM tidak akan ditekan terlepas dari nilai ini). Defaultnya adalah false.
properties.type	string	Menentukan jenis ekstensi; contohnya adalah "CustomScriptExtension".
properties.typeHandlerVersion	string	Menentukan versi handler skrip.

Respons

Nama	Jenis	Deskripsi
200 OK	VirtualMachineScaleSetVMExtension	Permintaan telah berhasil. Header Location: string Retry-After: integer
Other Status Codes	CloudError	Respons kesalahan tak terduga.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory.

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

Update VirtualMachineScaleSet VM extension.

Permintaan sampel

HTTP

PATCH https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myvmScaleSet/virtualMachines/0/extensions/myVMExtension?api-version=2025-11-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.models.VirtualMachineScaleSetVMExtensionUpdate;
import java.io.IOException;

/**
 * Samples for VirtualMachineScaleSetVMExtensions Update.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-11-01/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMExtension_Update.json
     */
    /**
     * Sample code: Update VirtualMachineScaleSet VM extension.
     * 
     * @param manager Entry point to ComputeManager.
     */
    public static void updateVirtualMachineScaleSetVMExtension(com.azure.resourcemanager.compute.ComputeManager manager)
        throws IOException {
        manager.serviceClient().getVirtualMachineScaleSetVMExtensions().update("myResourceGroup", "myvmScaleSet", "0",
            "myVMExtension",
            new VirtualMachineScaleSetVMExtensionUpdate().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_update.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_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: 2025-11-01/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMExtension_Update.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/v8"
)

// Generated from example definition: 2025-11-01/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMExtension_Update.json
func ExampleVirtualMachineScaleSetVMExtensionsClient_BeginUpdate() {
	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().BeginUpdate(ctx, "myResourceGroup", "myvmScaleSet", "0", "myVMExtension", armcompute.VirtualMachineScaleSetVMExtensionUpdate{
		Properties: &armcompute.VirtualMachineExtensionUpdateProperties{
			AutoUpgradeMinorVersion: to.Ptr(true),
			Publisher:               to.Ptr("extPublisher"),
			Type:                    to.Ptr("extType"),
			TypeHandlerVersion:      to.Ptr("1.2"),
			Settings: map[string]any{
				"UserName": "xyz@microsoft.com",
			},
		},
	}, 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 = armcompute.VirtualMachineScaleSetVMExtensionsClientUpdateResponse{
	// 	VirtualMachineScaleSetVMExtension: &armcompute.VirtualMachineScaleSetVMExtension{
	// 		Name: to.Ptr("myVMExtension"),
	// 		Type: to.Ptr("Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions"),
	// 		ID: to.Ptr("/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myvmScaleSet/virtualMachines/0/extensions/myVMExtension"),
	// 		Properties: &armcompute.VirtualMachineExtensionProperties{
	// 			AutoUpgradeMinorVersion: to.Ptr(true),
	// 			ProvisioningState: to.Ptr("Creating"),
	// 			Publisher: to.Ptr("extPublisher"),
	// 			Type: to.Ptr("extType"),
	// 			TypeHandlerVersion: to.Ptr("1.2"),
	// 			Settings: map[string]any{
	// 				"UserName": "xyz@microsoft.com",
	// 			},
	// 		},
	// 	},
	// }
}

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 update the VMSS VM extension.
 *
 * @summary the operation to update the VMSS VM extension.
 * x-ms-original-file: 2025-11-01/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMExtension_Update.json
 */
async function updateVirtualMachineScaleSetVMExtension() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "{subscription-id}";
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.virtualMachineScaleSetVMExtensions.update(
    "myResourceGroup",
    "myvmScaleSet",
    "0",
    "myVMExtension",
    {
      autoUpgradeMinorVersion: true,
      publisher: "extPublisher",
      typePropertiesType: "extType",
      typeHandlerVersion: "1.2",
      settings: { UserName: "xyz@microsoft.com" },
    },
  );
  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.Models;
using Azure.ResourceManager.Compute;

// Generated from example definition: specification/compute/resource-manager/Microsoft.Compute/Compute/stable/2025-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMExtension_Update.json
// this example is just showing the usage of "VirtualMachineScaleSetVMExtensions_Update" 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 VirtualMachineScaleSetVmExtensionResource created on azure
// for more information of creating VirtualMachineScaleSetVmExtensionResource, please refer to the document of VirtualMachineScaleSetVmExtensionResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "myResourceGroup";
string virtualMachineScaleSetName = "myvmScaleSet";
string instanceId = "0";
string vmExtensionName = "myVMExtension";
ResourceIdentifier virtualMachineScaleSetVmExtensionResourceId = VirtualMachineScaleSetVmExtensionResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, virtualMachineScaleSetName, instanceId, vmExtensionName);
VirtualMachineScaleSetVmExtensionResource virtualMachineScaleSetVmExtension = client.GetVirtualMachineScaleSetVmExtensionResource(virtualMachineScaleSetVmExtensionResourceId);

// invoke the operation
VirtualMachineScaleSetVmExtensionPatch patch = new VirtualMachineScaleSetVmExtensionPatch
{
    Publisher = "extPublisher",
    ExtensionType = "extType",
    TypeHandlerVersion = "1.2",
    AutoUpgradeMinorVersion = true,
    Settings = BinaryData.FromObjectAsJson(new
    {
        UserName = "xyz@microsoft.com",
    }),
};
ArmOperation<VirtualMachineScaleSetVmExtensionResource> lro = await virtualMachineScaleSetVmExtension.UpdateAsync(WaitUntil.Completed, patch);
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

Respon sampel

Kode status:

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

Definisi

Nama	Deskripsi
ApiError	Kesalahan API.
ApiErrorBase	Basis kesalahan API.
CloudError	Respons kesalahan dari layanan Komputasi.
InnerError	Detail kesalahan dalam.
InstanceViewStatus	Status tampilan instans.
KeyVaultSecretReference	Menjelaskan referensi ke Key Vault Secret
StatusLevelTypes	Kode tingkat.
SubResource
VirtualMachineExtensionInstanceView	Tampilan instans ekstensi komputer virtual.
VirtualMachineScaleSetVMExtension	Menjelaskan Ekstensi VM VMSS.
VirtualMachineScaleSetVMExtensionUpdate	Menjelaskan Ekstensi VM VMSS.

ApiError

Objek

Kesalahan API.

Nama	Jenis	Deskripsi
code	string	Kode kesalahan.
details	ApiErrorBase[]	Detail kesalahan Api
innererror	InnerError	Kesalahan dalam Api
message	string	Pesan kesalahan.
target	string	Target kesalahan tertentu.

ApiErrorBase

Objek

Basis kesalahan API.

Nama	Jenis	Deskripsi
code	string	Kode kesalahan.
message	string	Pesan kesalahan.
target	string	Target kesalahan tertentu.

CloudError

Objek

Respons kesalahan dari layanan Komputasi.

Nama	Jenis	Deskripsi
error	ApiError	Kesalahan API.

InnerError

Objek

Detail kesalahan dalam.

Nama	Jenis	Deskripsi
errordetail	string	Pesan kesalahan internal atau dump pengecualian.
exceptiontype	string	Jenis pengecualian.

InstanceViewStatus

Objek

Status tampilan instans.

Nama	Jenis	Deskripsi
code	string	Kode status.
displayStatus	string	Label pendek yang dapat dilokalkan untuk status tersebut.
level	StatusLevelTypes	Kode tingkat.
message	string	Pesan status terperinci, termasuk untuk pemberitahuan dan pesan kesalahan.
time	string (date-time)	Waktu status.

KeyVaultSecretReference

Objek

Menjelaskan referensi ke Key Vault Secret

Nama	Jenis	Deskripsi
secretUrl	string	URL yang mereferensikan rahasia di Key Vault.
sourceVault	SubResource	URL relatif Key Vault yang berisi rahasia.

StatusLevelTypes

Enumerasi

Kode tingkat.

Nilai	Deskripsi
Info
Warning
Error

SubResource

Objek

Nama	Jenis	Deskripsi
id	string	Id Sumber Daya

VirtualMachineExtensionInstanceView

Objek

Tampilan instans ekstensi komputer virtual.

Nama	Jenis	Deskripsi
name	string	Nama ekstensi komputer virtual.
statuses	InstanceViewStatus[]	Informasi status sumber daya.
substatuses	InstanceViewStatus[]	Informasi status sumber daya.
type	string	Menentukan jenis ekstensi; contohnya adalah "CustomScriptExtension".
typeHandlerVersion	string	Menentukan versi handler skrip.

VirtualMachineScaleSetVMExtension

Objek

Menjelaskan Ekstensi VM VMSS.

Nama	Jenis	Deskripsi
id	string	Id Sumber Daya
location	string	Lokasi ekstensi.
name	string	Nama sumber daya
properties.autoUpgradeMinorVersion	boolean	Menunjukkan apakah ekstensi harus menggunakan versi minor yang lebih baru jika tersedia pada waktu penyebaran. Namun, setelah disebarkan, ekstensi tidak akan meningkatkan versi minor kecuali disebarkan ulang, bahkan dengan properti ini diatur ke true.
properties.enableAutomaticUpgrade	boolean	Menunjukkan apakah ekstensi harus ditingkatkan secara otomatis oleh platform jika ada versi ekstensi yang lebih baru yang tersedia.
properties.forceUpdateTag	string	Bagaimana handler ekstensi harus diperbarui meskipun konfigurasi ekstensi belum berubah.
properties.instanceView	VirtualMachineExtensionInstanceView	Tampilan instans ekstensi komputer virtual.
properties.protectedSettings		Ekstensi dapat berisi protectedSettings atau protectedSettingsFromKeyVault atau tidak ada pengaturan yang dilindungi sama sekali.
properties.protectedSettingsFromKeyVault	KeyVaultSecretReference	Pengaturan yang dilindungi ekstensi yang diteruskan oleh referensi, dan dikonsumsi dari brankas kunci
properties.provisionAfterExtensions	string[]	Kumpulan nama ekstensi setelah ekstensi ini perlu disediakan.
properties.provisioningState	string	Status provisi, yang hanya muncul dalam respons.
properties.publisher	string	Nama penerbit handler ekstensi.
properties.settings		Pengaturan publik berformat Json untuk ekstensi.
properties.suppressFailures	boolean	Menunjukkan apakah kegagalan yang berasal dari ekstensi akan ditekan (Kegagalan operasional seperti tidak terhubung ke VM tidak akan ditekan terlepas dari nilai ini). Defaultnya adalah false.
properties.type	string	Menentukan jenis ekstensi; contohnya adalah "CustomScriptExtension".
properties.typeHandlerVersion	string	Menentukan versi handler skrip.
type	string	Jenis sumber daya

VirtualMachineScaleSetVMExtensionUpdate

Objek

Menjelaskan Ekstensi VM VMSS.

Nama	Jenis	Deskripsi
id	string	Id Sumber Daya
name	string	Nama ekstensi.
properties.autoUpgradeMinorVersion	boolean	Menunjukkan apakah ekstensi harus menggunakan versi minor yang lebih baru jika tersedia pada waktu penyebaran. Namun, setelah disebarkan, ekstensi tidak akan meningkatkan versi minor kecuali disebarkan ulang, bahkan dengan properti ini diatur ke true.
properties.enableAutomaticUpgrade	boolean	Menunjukkan apakah ekstensi harus ditingkatkan secara otomatis oleh platform jika ada versi ekstensi yang lebih baru yang tersedia.
properties.forceUpdateTag	string	Bagaimana handler ekstensi harus diperbarui meskipun konfigurasi ekstensi belum berubah.
properties.protectedSettings		Ekstensi dapat berisi protectedSettings atau protectedSettingsFromKeyVault atau tidak ada pengaturan yang dilindungi sama sekali.
properties.protectedSettingsFromKeyVault	KeyVaultSecretReference	Pengaturan yang dilindungi ekstensi yang diteruskan oleh referensi, dan dikonsumsi dari brankas kunci
properties.publisher	string	Nama penerbit handler ekstensi.
properties.settings		Pengaturan publik berformat Json untuk ekstensi.
properties.suppressFailures	boolean	Menunjukkan apakah kegagalan yang berasal dari ekstensi akan ditekan (Kegagalan operasional seperti tidak terhubung ke VM tidak akan ditekan terlepas dari nilai ini). Defaultnya adalah false.
properties.type	string	Menentukan jenis ekstensi; contohnya adalah "CustomScriptExtension".
properties.typeHandlerVersion	string	Menentukan versi handler skrip.
type	string	Jenis sumber daya