Accounts - Change Key Vault

Layanan:: Azure NetApp Files

Versi API:: 2026-04-01

Mempengaruhi volume yang ada yang dienkripsi dengan HSM Key Vault/Terkelola, dan volume baru. Mendukung HSM untuk Key Vault, Key Vault ke HSM, HSM ke HSM dan Key Vault ke Key Vault.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/changeKeyVault?api-version=2026-04-01

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
accountName	path	True	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_]{0,127}$	Nama akun NetApp
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 (uuid)	ID langganan target. Nilainya harus sebuah UUID.
api-version	query	True	string minLength: 1	Versi API yang akan digunakan untuk operasi ini.

Isi Permintaan

Nama	Diperlukan	Jenis	Deskripsi
keyName	True	string	Nama kunci yang harus digunakan untuk enkripsi.
keyVaultPrivateEndpoints	True	KeyVaultPrivateEndpoint[]	Pasangan ID jaringan virtual dan ID titik akhir privat. Setiap jaringan virtual yang memiliki volume yang dienkripsi dengan kunci yang dikelola pelanggan memerlukan titik akhir privat brankas kuncinya sendiri.
keyVaultUri	True	string (uri)	URI brankas kunci/HSM terkelola yang harus digunakan untuk enkripsi.
keyVaultResourceId		string (arm-id)	Azure ID sumber daya dari brankas kunci/HSM terkelola yang harus digunakan untuk enkripsi.

Respons

Nama	Jenis	Deskripsi
202 Accepted		Operasi sumber daya diterima. Header Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Respons kesalahan yang tidak terduga.

Nama

Jenis

Deskripsi

202 Accepted

Operasi sumber daya diterima.

Header

Location: string
Retry-After: integer

Other Status Codes

ErrorResponse

Respons kesalahan yang tidak 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

Accounts_ChangeKeyVault

Permintaan sampel

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/changeKeyVault?api-version=2026-04-01

{
  "keyName": "rsakey",
  "keyVaultPrivateEndpoints": [
    {
      "privateEndpointId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.Network/privateEndpoints/privip1",
      "virtualNetworkId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.Network/virtualNetworks/vnet1"
    }
  ],
  "keyVaultResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.KeyVault/managedHSMs/my-hsm",
  "keyVaultUri": "https://my-key-vault.managedhsm.azure.net"
}


import com.azure.resourcemanager.netapp.models.ChangeKeyVault;
import com.azure.resourcemanager.netapp.models.KeyVaultPrivateEndpoint;
import java.util.Arrays;

/**
 * Samples for Accounts ChangeKeyVault.
 */
public final class Main {
    /*
     * x-ms-original-file: 2026-04-01/Accounts_ChangeKeyVault.json
     */
    /**
     * Sample code: Accounts_ChangeKeyVault.
     * 
     * @param manager Entry point to NetAppFilesManager.
     */
    public static void accountsChangeKeyVault(com.azure.resourcemanager.netapp.NetAppFilesManager manager) {
        manager.accounts().changeKeyVault("myRG", "account1", new ChangeKeyVault()
            .withKeyVaultUri("fakeTokenPlaceholder").withKeyName("fakeTokenPlaceholder")
            .withKeyVaultResourceId("fakeTokenPlaceholder")
            .withKeyVaultPrivateEndpoints(Arrays.asList(new KeyVaultPrivateEndpoint().withVirtualNetworkId(
                "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.Network/virtualNetworks/vnet1")
                .withPrivateEndpointId(
                    "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.Network/privateEndpoints/privip1"))),
            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.netapp import NetAppManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-netapp
# USAGE
    python accounts_change_key_vault.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 = NetAppManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    client.accounts.begin_change_key_vault(
        resource_group_name="myRG",
        account_name="account1",
    ).result()


# x-ms-original-file: 2026-04-01/Accounts_ChangeKeyVault.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 armnetapp_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/netapp/armnetapp/v10"
)

// Generated from example definition: 2026-04-01/Accounts_ChangeKeyVault.json
func ExampleAccountsClient_BeginChangeKeyVault() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armnetapp.NewClientFactory("00000000-0000-0000-0000-000000000000", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewAccountsClient().BeginChangeKeyVault(ctx, "myRG", "account1", &armnetapp.AccountsClientBeginChangeKeyVaultOptions{
		Body: &armnetapp.ChangeKeyVault{
			KeyName: to.Ptr("rsakey"),
			KeyVaultPrivateEndpoints: []*armnetapp.KeyVaultPrivateEndpoint{
				{
					PrivateEndpointID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.Network/privateEndpoints/privip1"),
					VirtualNetworkID:  to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.Network/virtualNetworks/vnet1"),
				},
			},
			KeyVaultResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.KeyVault/managedHSMs/my-hsm"),
			KeyVaultURI:        to.Ptr("https://my-key-vault.managedhsm.azure.net"),
		}})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to poll the result: %v", err)
	}
}

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

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

/**
 * This sample demonstrates how to affects existing volumes that are encrypted with Key Vault/Managed HSM, and new volumes. Supports HSM to Key Vault, Key Vault to HSM, HSM to HSM and Key Vault to Key Vault.
 *
 * @summary affects existing volumes that are encrypted with Key Vault/Managed HSM, and new volumes. Supports HSM to Key Vault, Key Vault to HSM, HSM to HSM and Key Vault to Key Vault.
 * x-ms-original-file: 2026-04-01/Accounts_ChangeKeyVault.json
 */
async function accountsChangeKeyVault() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-0000-0000-0000-000000000000";
  const client = new NetAppManagementClient(credential, subscriptionId);
  await client.accounts.changeKeyVault("myRG", "account1", {
    body: {
      keyName: "rsakey",
      keyVaultPrivateEndpoints: [
        {
          privateEndpointId:
            "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.Network/privateEndpoints/privip1",
          virtualNetworkId:
            "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.Network/virtualNetworks/vnet1",
        },
      ],
      keyVaultResourceId:
        "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.KeyVault/managedHSMs/my-hsm",
      keyVaultUri: "https://my-key-vault.managedhsm.azure.net",
    },
  });
}

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:: 202

Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.NetApp/locations/eastus/operationResults/a0216c17-f9d6-4b99-9faf-9ebd4883d0e4?api-version=2026-04-01&operationResultResponseType=Location

Definisi

Nama	Deskripsi
ChangeKeyVault	Mengubah permintaan brankas kunci
ErrorAdditionalInfo	Informasi tambahan tentang kesalahan pengelolaan sumber daya.
ErrorDetail	Detail kesalahan.
ErrorResponse	Tanggapan kesalahan
KeyVaultPrivateEndpoint	Pasangan ID jaringan virtual dan ID titik akhir privat. Setiap jaringan virtual yang memiliki volume yang dienkripsi dengan kunci yang dikelola pelanggan memerlukan titik akhir privat brankas kuncinya sendiri.

ChangeKeyVault

Objek

Mengubah permintaan brankas kunci

Nama	Jenis	Deskripsi
keyName	string	Nama kunci yang harus digunakan untuk enkripsi.
keyVaultPrivateEndpoints	KeyVaultPrivateEndpoint[]	Pasangan ID jaringan virtual dan ID titik akhir privat. Setiap jaringan virtual yang memiliki volume yang dienkripsi dengan kunci yang dikelola pelanggan memerlukan titik akhir privat brankas kuncinya sendiri.
keyVaultResourceId	string (arm-id)	Azure ID sumber daya dari brankas kunci/HSM terkelola yang harus digunakan untuk enkripsi.
keyVaultUri	string (uri)	URI brankas kunci/HSM terkelola yang harus digunakan untuk enkripsi.

ErrorAdditionalInfo

Objek

Informasi tambahan tentang kesalahan pengelolaan sumber daya.

Nama	Jenis	Deskripsi
info	object	Info tambahan.
type	string	Jenis informasi tambahan.

ErrorDetail

Objek

Detail kesalahan.

Nama	Jenis	Deskripsi
additionalInfo	ErrorAdditionalInfo[]	Informasi tambahan tentang kesalahan.
code	string	Kode kesalahan.
details	ErrorDetail[]	Rincian kesalahan.
message	string	Pesan kesalahan.
target	string	Sasaran kesalahan.

ErrorResponse

Objek

Tanggapan kesalahan

Nama	Jenis	Deskripsi
error	ErrorDetail	Objek kesalahan.

KeyVaultPrivateEndpoint

Objek

Pasangan ID jaringan virtual dan ID titik akhir privat. Setiap jaringan virtual yang memiliki volume yang dienkripsi dengan kunci yang dikelola pelanggan memerlukan titik akhir privat brankas kuncinya sendiri.

Nama	Jenis	Deskripsi
privateEndpointId	string (arm-id)	Pengidentifikasi titik akhir privat untuk mencapai Azure Key Vault
virtualNetworkId	string (arm-id)	Pengidentifikasi untuk id jaringan virtual