Virtual Machine Extensions - Update

Reference

Služba:: Compute

Verze rozhraní API:: 2024-07-01

Operace aktualizace rozšíření.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
resourceGroupName	path	True	string	Název skupiny prostředků.
subscriptionId	path	True	string	Přihlašovací údaje předplatného, které jednoznačně identifikují předplatné Microsoft Azure. ID předplatného tvoří součást identifikátoru URI pro každé volání služby.
vmExtensionName	path	True	string	Název rozšíření virtuálního počítače
vmName	path	True	string	Název virtuálního počítače, na kterém se má rozšíření aktualizovat.
api-version	query	True	string	Verze rozhraní API klienta.

Text požadavku

Name	Typ	Description
properties.autoUpgradeMinorVersion	boolean	Určuje, jestli má rozšíření používat novější podverzi, pokud je k dispozici v době nasazení. Po nasazení však rozšíření neupgraduje podverze, pokud se znovu nenasadí, a to ani s touto vlastností nastavenou na true.
properties.enableAutomaticUpgrade	boolean	Určuje, jestli má být rozšíření automaticky upgradováno platformou, pokud je k dispozici novější verze rozšíření.
properties.forceUpdateTag	string	Způsob vynucení aktualizace obslužné rutiny rozšíření i v případě, že se konfigurace rozšíření nezměnila.
properties.protectedSettings	object	Rozšíření může obsahovat buď protectedSettings, nebo protectedSettingsFromKeyVault, nebo vůbec žádná chráněná nastavení.
properties.protectedSettingsFromKeyVault	KeyVaultSecretReference	Nastavení chráněná rozšířeními, která jsou předána odkazem, a spotřebovaná z trezoru klíčů
properties.publisher	string	Název vydavatele obslužné rutiny rozšíření.
properties.settings	object	Veřejná nastavení formátovaná json pro rozšíření
properties.suppressFailures	boolean	Určuje, jestli se potlačí selhání vyplývající z rozšíření (provozní selhání, jako je například nepřipojování k virtuálnímu počítači, nebudou potlačována bez ohledu na tuto hodnotu). Výchozí hodnota je false.
properties.type	string	Určuje typ rozšíření; Příkladem je CustomScriptExtension.
properties.typeHandlerVersion	string	Určuje verzi obslužné rutiny skriptu.
tags	object	Značky prostředků

Odpovědi

Name	Typ	Description
200 OK	VirtualMachineExtension	OK
Other Status Codes	CloudError	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

Update VM extension.

Ukázkový požadavek

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

{
  "properties": {
    "autoUpgradeMinorVersion": true,
    "publisher": "extPublisher",
    "type": "extType",
    "typeHandlerVersion": "1.2",
    "suppressFailures": true,
    "settings": {
      "UserName": "xyz@microsoft.com"
    },
    "protectedSettingsFromKeyVault": {
      "sourceVault": {
        "id": "/subscriptions/a53f7094-a16c-47af-abe4-b05c05d0d79a/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/kvName"
      },
      "secretUrl": "https://kvName.vault.azure.net/secrets/secretName/79b88b3a6f5440ffb2e73e44a0db712e"
    }
  }
}


import com.azure.core.management.SubResource;
import com.azure.core.management.serializer.SerializerFactory;
import com.azure.core.util.serializer.SerializerEncoding;
import com.azure.resourcemanager.compute.models.KeyVaultSecretReference;
import com.azure.resourcemanager.compute.models.VirtualMachineExtensionUpdate;
import java.io.IOException;

/**
 * Samples for VirtualMachineExtensions Update.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/
     * virtualMachineExamples/VirtualMachineExtension_Update.json
     */
    /**
     * Sample code: Update VM extension.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void updateVMExtension(com.azure.resourcemanager.AzureResourceManager azure) throws IOException {
        azure.virtualMachines().manager().serviceClient().getVirtualMachineExtensions().update("myResourceGroup",
            "myVM", "myVMExtension",
            new VirtualMachineExtensionUpdate().withPublisher("extPublisher").withType("extType")
                .withTypeHandlerVersion("1.2").withAutoUpgradeMinorVersion(true)
                .withSettings(SerializerFactory.createDefaultManagementSerializerAdapter()
                    .deserialize("{\"UserName\":\"xyz@microsoft.com\"}", Object.class, SerializerEncoding.JSON))
                .withSuppressFailures(true)
                .withProtectedSettingsFromKeyVault(new KeyVaultSecretReference().withSecretUrl("fakeTokenPlaceholder")
                    .withSourceVault(new SubResource().withId(
                        "/subscriptions/a53f7094-a16c-47af-abe4-b05c05d0d79a/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/kvName"))),
            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

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_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_extensions.begin_update(
        resource_group_name="myResourceGroup",
        vm_name="myVM",
        vm_extension_name="myVMExtension",
        extension_parameters={
            "properties": {
                "autoUpgradeMinorVersion": True,
                "protectedSettingsFromKeyVault": {
                    "secretUrl": "https://kvName.vault.azure.net/secrets/secretName/79b88b3a6f5440ffb2e73e44a0db712e",
                    "sourceVault": {
                        "id": "/subscriptions/a53f7094-a16c-47af-abe4-b05c05d0d79a/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/kvName"
                    },
                },
                "publisher": "extPublisher",
                "settings": {"UserName": "xyz@microsoft.com"},
                "suppressFailures": True,
                "type": "extType",
                "typeHandlerVersion": "1.2",
            }
        },
    ).result()
    print(response)


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

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/virtualMachineExamples/VirtualMachineExtension_Update.json
func ExampleVirtualMachineExtensionsClient_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.NewVirtualMachineExtensionsClient().BeginUpdate(ctx, "myResourceGroup", "myVM", "myVMExtension", armcompute.VirtualMachineExtensionUpdate{
		Properties: &armcompute.VirtualMachineExtensionUpdateProperties{
			Type:                    to.Ptr("extType"),
			AutoUpgradeMinorVersion: to.Ptr(true),
			ProtectedSettingsFromKeyVault: &armcompute.KeyVaultSecretReference{
				SecretURL: to.Ptr("https://kvName.vault.azure.net/secrets/secretName/79b88b3a6f5440ffb2e73e44a0db712e"),
				SourceVault: &armcompute.SubResource{
					ID: to.Ptr("/subscriptions/a53f7094-a16c-47af-abe4-b05c05d0d79a/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/kvName"),
				},
			},
			Publisher: to.Ptr("extPublisher"),
			Settings: map[string]any{
				"UserName": "xyz@microsoft.com",
			},
			SuppressFailures:   to.Ptr(true),
			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.VirtualMachineExtension = armcompute.VirtualMachineExtension{
	// 	Name: to.Ptr("myVMExtension"),
	// 	Type: to.Ptr("Microsoft.Compute/virtualMachines/extensions"),
	// 	ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM/extensions/myVMExtension"),
	// 	Location: to.Ptr("westus"),
	// 	Properties: &armcompute.VirtualMachineExtensionProperties{
	// 		Type: to.Ptr("extType"),
	// 		AutoUpgradeMinorVersion: to.Ptr(true),
	// 		ProtectedSettingsFromKeyVault: &armcompute.KeyVaultSecretReference{
	// 			SecretURL: to.Ptr("https://kvName.vault.azure.net/secrets/secretName/79b88b3a6f5440ffb2e73e44a0db712e"),
	// 			SourceVault: &armcompute.SubResource{
	// 				ID: to.Ptr("/subscriptions/a53f7094-a16c-47af-abe4-b05c05d0d79a/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/kvName"),
	// 			},
	// 		},
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 		Publisher: to.Ptr("extPublisher"),
	// 		Settings: map[string]any{
	// 			"UserName": "xyz@microsoft.com",
	// 		},
	// 		SuppressFailures: to.Ptr(true),
	// 		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

const { ComputeManagementClient } = require("@azure/arm-compute");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to The operation to update the extension.
 *
 * @summary The operation to update the extension.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/virtualMachineExamples/VirtualMachineExtension_Update.json
 */
async function updateVMExtension() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["COMPUTE_RESOURCE_GROUP"] || "myResourceGroup";
  const vmName = "myVM";
  const vmExtensionName = "myVMExtension";
  const extensionParameters = {
    type: "extType",
    autoUpgradeMinorVersion: true,
    protectedSettingsFromKeyVault: {
      secretUrl:
        "https://kvName.vault.azure.net/secrets/secretName/79b88b3a6f5440ffb2e73e44a0db712e",
      sourceVault: {
        id: "/subscriptions/a53f7094-a16c-47af-abe4-b05c05d0d79a/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/kvName",
      },
    },
    publisher: "extPublisher",
    settings: { UserName: "xyz@microsoft.com" },
    suppressFailures: true,
    typeHandlerVersion: "1.2",
  };
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.virtualMachineExtensions.beginUpdateAndWait(
    resourceGroupName,
    vmName,
    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

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.Resources.Models;
using Azure.ResourceManager.Compute;

// Generated from example definition: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/virtualMachineExamples/VirtualMachineExtension_Update.json
// this example is just showing the usage of "VirtualMachineExtensions_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 VirtualMachineExtensionResource created on azure
// for more information of creating VirtualMachineExtensionResource, please refer to the document of VirtualMachineExtensionResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "myResourceGroup";
string vmName = "myVM";
string vmExtensionName = "myVMExtension";
ResourceIdentifier virtualMachineExtensionResourceId = VirtualMachineExtensionResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, vmName, vmExtensionName);
VirtualMachineExtensionResource virtualMachineExtension = client.GetVirtualMachineExtensionResource(virtualMachineExtensionResourceId);

// invoke the operation
VirtualMachineExtensionPatch patch = new VirtualMachineExtensionPatch
{
    Publisher = "extPublisher",
    ExtensionType = "extType",
    TypeHandlerVersion = "1.2",
    AutoUpgradeMinorVersion = true,
    Settings = BinaryData.FromObjectAsJson(new
    {
        UserName = "xyz@microsoft.com",
    }),
    SuppressFailures = true,
    KeyVaultProtectedSettings = new KeyVaultSecretReference(new Uri("https://kvName.vault.azure.net/secrets/secretName/79b88b3a6f5440ffb2e73e44a0db712e"), new WritableSubResource
    {
        Id = new ResourceIdentifier("/subscriptions/a53f7094-a16c-47af-abe4-b05c05d0d79a/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/kvName"),
    }),
};
ArmOperation<VirtualMachineExtensionResource> lro = await virtualMachineExtension.UpdateAsync(WaitUntil.Completed, patch);
VirtualMachineExtensionResource 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
VirtualMachineExtensionData 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

Ukázková odpověď

Stavový kód:: 200

{
  "name": "myVMExtension",
  "type": "Microsoft.Compute/virtualMachines/extensions",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM/extensions/myVMExtension",
  "location": "westus",
  "properties": {
    "autoUpgradeMinorVersion": true,
    "provisioningState": "Creating",
    "publisher": "extPublisher",
    "type": "extType",
    "typeHandlerVersion": "1.2",
    "suppressFailures": true,
    "settings": {
      "UserName": "xyz@microsoft.com"
    },
    "protectedSettingsFromKeyVault": {
      "sourceVault": {
        "id": "/subscriptions/a53f7094-a16c-47af-abe4-b05c05d0d79a/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/kvName"
      },
      "secretUrl": "https://kvName.vault.azure.net/secrets/secretName/79b88b3a6f5440ffb2e73e44a0db712e"
    }
  }
}

Definice

Name	Description
ApiError	Chyba rozhraní API
ApiErrorBase	Základ chyb rozhraní API.
CloudError	Odpověď na chybu z výpočetní služby
InnerError	Podrobnosti vnitřní chyby.
InstanceViewStatus	Stav zobrazení instance
KeyVaultSecretReference	Popisuje odkaz na tajný klíč služby Key Vault.
StatusLevelTypes	Kód úrovně.
SubResource
VirtualMachineExtension	Popisuje rozšíření virtuálního počítače.
VirtualMachineExtensionInstanceView	Zobrazení instance rozšíření virtuálního počítače.
VirtualMachineExtensionUpdate	Popisuje rozšíření virtuálního počítače.

ApiError

Chyba rozhraní API

Name	Typ	Description
code	string	Kód chyby.
details	ApiErrorBase[]	Podrobnosti o chybě rozhraní API
innererror	InnerError	Vnitřní chyba rozhraní API
message	string	Chybová zpráva.
target	string	Cíl konkrétní chyby.

ApiErrorBase

Základ chyb rozhraní API.

Name	Typ	Description
code	string	Kód chyby.
message	string	Chybová zpráva.
target	string	Cíl konkrétní chyby.

CloudError

Odpověď na chybu z výpočetní služby

Name	Typ	Description
error	ApiError	Chyba rozhraní API

InnerError

Podrobnosti vnitřní chyby.

Name	Typ	Description
errordetail	string	Vnitřní chybová zpráva nebo výpis výjimky.
exceptiontype	string	Typ výjimky.

InstanceViewStatus

Stav zobrazení instance

Name	Typ	Description
code	string	Stavový kód.
displayStatus	string	Krátký lokalizovatelný popisek stavu.
level	StatusLevelTypes	Kód úrovně.
message	string	Podrobná stavová zpráva, včetně výstrah a chybových zpráv.
time	string	Čas stavu.

KeyVaultSecretReference

Popisuje odkaz na tajný klíč služby Key Vault.

Name	Typ	Description
secretUrl	string	Adresa URL odkazující na tajný kód ve službě Key Vault.
sourceVault	SubResource	Relativní adresa URL služby Key Vault obsahující tajný klíč.

StatusLevelTypes

Kód úrovně.

Name	Typ	Description
Error	string
Info	string
Warning	string

SubResource

Name	Typ	Description
id	string	ID prostředku

VirtualMachineExtension

Popisuje rozšíření virtuálního počítače.

Name	Typ	Description
id	string	ID prostředku
location	string	Umístění prostředku
name	string	Název prostředku
properties.autoUpgradeMinorVersion	boolean	Určuje, jestli má rozšíření používat novější podverzi, pokud je k dispozici v době nasazení. Po nasazení však rozšíření neupgraduje podverze, pokud se znovu nenasadí, a to ani s touto vlastností nastavenou na true.
properties.enableAutomaticUpgrade	boolean	Určuje, jestli má být rozšíření automaticky upgradováno platformou, pokud je k dispozici novější verze rozšíření.
properties.forceUpdateTag	string	Způsob vynucení aktualizace obslužné rutiny rozšíření i v případě, že se konfigurace rozšíření nezměnila.
properties.instanceView	VirtualMachineExtensionInstanceView	Zobrazení instance rozšíření virtuálního počítače.
properties.protectedSettings	object	Rozšíření může obsahovat buď protectedSettings, nebo protectedSettingsFromKeyVault, nebo vůbec žádná chráněná nastavení.
properties.protectedSettingsFromKeyVault	KeyVaultSecretReference	Nastavení chráněná rozšířeními, která jsou předána odkazem, a spotřebovaná z trezoru klíčů
properties.provisionAfterExtensions	string[]	Kolekce názvů rozšíření, po kterých je potřeba toto rozšíření zřídit.
properties.provisioningState	string	Stav zřizování, který se zobrazí pouze v odpovědi.
properties.publisher	string	Název vydavatele obslužné rutiny rozšíření.
properties.settings	object	Veřejná nastavení formátovaná json pro rozšíření
properties.suppressFailures	boolean	Určuje, jestli se potlačí selhání vyplývající z rozšíření (provozní selhání, jako je například nepřipojování k virtuálnímu počítači, nebudou potlačována bez ohledu na tuto hodnotu). Výchozí hodnota je false.
properties.type	string	Určuje typ rozšíření; Příkladem je CustomScriptExtension.
properties.typeHandlerVersion	string	Určuje verzi obslužné rutiny skriptu.
tags	object	Značky prostředků
type	string	Typ prostředku

VirtualMachineExtensionInstanceView

Zobrazení instance rozšíření virtuálního počítače.

Name	Typ	Description
name	string	Název rozšíření virtuálního počítače.
statuses	InstanceViewStatus[]	Informace o stavu zdroje
substatuses	InstanceViewStatus[]	Informace o stavu zdroje
type	string	Určuje typ rozšíření; Příkladem je CustomScriptExtension.
typeHandlerVersion	string	Určuje verzi obslužné rutiny skriptu.

VirtualMachineExtensionUpdate

Popisuje rozšíření virtuálního počítače.

Name	Typ	Description
properties.autoUpgradeMinorVersion	boolean	Určuje, jestli má rozšíření používat novější podverzi, pokud je k dispozici v době nasazení. Po nasazení však rozšíření neupgraduje podverze, pokud se znovu nenasadí, a to ani s touto vlastností nastavenou na true.
properties.enableAutomaticUpgrade	boolean	Určuje, jestli má být rozšíření automaticky upgradováno platformou, pokud je k dispozici novější verze rozšíření.
properties.forceUpdateTag	string	Způsob vynucení aktualizace obslužné rutiny rozšíření i v případě, že se konfigurace rozšíření nezměnila.
properties.protectedSettings	object	Rozšíření může obsahovat buď protectedSettings, nebo protectedSettingsFromKeyVault, nebo vůbec žádná chráněná nastavení.
properties.protectedSettingsFromKeyVault	KeyVaultSecretReference	Nastavení chráněná rozšířeními, která jsou předána odkazem, a spotřebovaná z trezoru klíčů
properties.publisher	string	Název vydavatele obslužné rutiny rozšíření.
properties.settings	object	Veřejná nastavení formátovaná json pro rozšíření
properties.suppressFailures	boolean	Určuje, jestli se potlačí selhání vyplývající z rozšíření (provozní selhání, jako je například nepřipojování k virtuálnímu počítači, nebudou potlačována bez ohledu na tuto hodnotu). Výchozí hodnota je false.
properties.type	string	Určuje typ rozšíření; Příkladem je CustomScriptExtension.
properties.typeHandlerVersion	string	Určuje verzi obslužné rutiny skriptu.
tags	object	Značky prostředků