Managed Instance Encryption Protectors - Create Or Update

Service:

SQL Database

API Version:

2021-11-01

Updates pelindung enkripsi yang ada.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/encryptionProtector/current?api-version=2021-11-01

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
encryptionProtectorName	path	True	EncryptionProtectorName	Nama pelindung enkripsi yang akan diperbarui.
managedInstanceName	path	True	string	Nama instans terkelola.
resourceGroupName	path	True	string	Nama grup sumber daya yang berisi sumber daya. Anda dapat memperoleh nilai ini dari Azure Resource Manager API atau portal.
subscriptionId	path	True	string	ID langganan yang mengidentifikasi langganan Azure.
api-version	query	True	string	Versi API yang digunakan untuk permintaan.

Isi Permintaan

Nama	Diperlukan	Jenis	Deskripsi
properties.serverKeyType	True	ServerKeyType	Jenis pelindung enkripsi seperti 'ServiceManaged', 'AzureKeyVault'.
properties.autoRotationEnabled		boolean	Bendera keikutsertaan rotasi otomatis kunci. Baik true maupun false.
properties.serverKeyName		string	Nama kunci instans terkelola.

Respons

Nama	Jenis	Deskripsi
200 OK	ManagedInstanceEncryptionProtector	Berhasil memperbarui pelindung enkripsi.
202 Accepted		Diterima
Other Status Codes		Respons Kesalahan: *** 400 InvalidKeyName - Nilai yang tidak valid diberikan untuk nama kunci server. 400 InvalidKeyType - Jenis kunci buat server tidak didukung. 400 InvalidUpsertKeyType - Kunci TDE yang dikelola layanan dikelola oleh layanan. Kunci TDE yang dikelola layanan tidak mendukung Buat atau Perbarui oleh pengguna. 400 InvalidKeyUpsertRequest - Permintaan buat kunci server tidak ada atau tidak memiliki objek properti. 400 InvalidEncryptionProtectorName - Nama kunci pelindung enkripsi tidak didukung. 400 SecurityAdalPrincipalCertExpiredError - Operasi tidak dapat diselesaikan karena sertifikat utama Azure Key Vault telah kedaluwarsa. 400 AkvHostNotResolvingFromNode - Host AKV '{0}' tidak dapat diselesaikan dari SQL, di server '{1}'. 400 SecurityInvalidAzureKeyVaultRecoveryLevel - Uri Key Vault yang disediakan tidak valid. 400 KeyMaterialNotFoundOnRemoteServer - Server jarak jauh tidak memiliki akses ke materi kunci yang digunakan sebagai pelindung TDE. 400 AzureKeyVaultRsaKeyNotSupported - Brankas kunci yang disediakan menggunakan Ukuran Kunci RSA atau Jenis Kunci yang tidak didukung. Ukuran kunci RSA yang didukung adalah 2048 atau 3072 dan Jenis Kunci adalah RSA atau RSA-HSM. 400 AzureKeyVaultKeyDisabled - Operasi tidak dapat diselesaikan di server karena kunci Azure Key Vault dinonaktifkan. 400 AzureKeyVaultInvalidExpirationDate - Operasi tidak dapat diselesaikan karena tanggal kedaluwarsa kunci Azure Key Vault tidak valid. 400 SameKeyUriNotFoundOnRemoteServer - Server sekunder tidak memiliki materi kunci dari brankas kunci yang sama dengan pelindung enkripsi server utama dengan rotasi otomatis kunci diaktifkan. 400 SecurityAzureKeyVaultUrlNullOrEmpty - Operasi tidak dapat diselesaikan karena Azure Key Vault Uri null atau kosong. 400 SameKeyMaterialNotFoundOnRemoteServer - Server sekunder tidak memiliki materi kunci pelindung enkripsi server utama. 400 PerDatabaseCMKRestoreNotSupported - Pemulihan database tidak didukung saat CMK tingkat Database dikonfigurasi dalam pratinjau. 400 AzureKeyVaultNoServerIdentity - Identitas server tidak dikonfigurasi dengan benar. 400 PerDatabaseCMKHSNotSupported - CMK tingkat database dalam pratinjau tidak didukung untuk edisi Hyperscale. 400 AzureKeyVaultInvalidUri - Respons yang tidak valid dari Azure Key Vault. Gunakan URI Key Vault Azure yang valid. 400 AzureKeyVaultMissingPermissions - Server kehilangan izin yang diperlukan di Azure Key Vault. 400 UmiMissingAkvPermissions - PrimaryUserAssignedIdentityId yang disediakan oleh pengguna tidak memiliki akses ke KeyId yang disediakan 400 AkvEndpointNotReachableFromNode - Titik akhir AKV '{0}' tidak dapat dijangkau dari SQL, di server '{1}'. 400 SecurityAzureKeyVaultInvalidKeyName - Operasi tidak dapat diselesaikan karena nama Kunci Server yang tidak valid. 400 AdalGenericError - Operasi tidak dapat diselesaikan karena terjadi kesalahan Azure Active Directory. 400 AdalServicePrincipalNotFound - Operasi tidak dapat diselesaikan karena Perwakilan Layanan pustaka Azure Active Directory tidak menemukan kesalahan. 400 AzureKeyVaultMalformedVaultUri - Uri Key Vault yang disediakan tidak valid. 400 KeamananAzureKeyVaultGeoChainError - Membuat sekunder sekunder (proses yang dikenal sebagai penautan) tidak didukung saat mengaktifkan Enkripsi Data Transparan menggunakan Azure Key Vault (BYOK). 400 PerDatabaseCMKDWNotSupported - CMK tingkat database dalam pratinjau tidak didukung untuk edisi Gudang Data. 404 SubscriptionDoesNotHaveServer - Server yang diminta tidak ditemukan 404 ServerNotInSubscriptionResourceGroup - Server yang ditentukan tidak ada di grup sumber daya dan langganan yang ditentukan. 404 ResourceNotFound - Sumber daya yang diminta tidak ditemukan. 404 ServerKeyNotFound - Kunci server yang diminta tidak ditemukan pada langganan saat ini. 404 OperationIdNotFound - Operasi dengan Id tidak ada. 409 EncryptionProtectorChangeInProgress - Tidak dapat memperbarui pelindung kunci enkripsi database saat perubahan pelindung sedang berlangsung 409 ServerKeyNameAlreadyExists - Kunci server sudah ada di server. 409 ServerKeyUriAlreadyExists - URI kunci server sudah ada di server. 409 ServerKeyDoesNotExists - Kunci server tidak ada. 409 AzureKeyVaultKeyNameNotFound - Operasi tidak dapat diselesaikan karena nama Azure Key Vault Key tidak ada. 409 AzureKeyVaultKeyInUse - Kunci saat ini sedang digunakan oleh server. 409 OperationCancelled - Operasi telah dibatalkan oleh pengguna. 409 OperationInterrupted - Operasi pada sumber daya tidak dapat diselesaikan karena terganggu oleh operasi lain pada sumber daya yang sama. 429 SubscriptionTooManyCreateUpdateRequests - Permintaan di luar permintaan maks yang dapat diproses oleh sumber daya yang tersedia. 429 SubscriptionTooManyRequests - Permintaan di luar permintaan maks yang dapat diproses oleh sumber daya yang tersedia. 500 OperationTimedOut - Waktu operasi habis dan secara otomatis digulung balik. Coba lagi operasi ini. 503 AzureKeyVaultConnectionFailed - Operasi tidak dapat diselesaikan di server karena upaya untuk menyambungkan ke Azure Key Vault gagal 503 AzureKeyVaultGenericConnectionError - Operasi tidak dapat diselesaikan karena terjadi kesalahan saat mencoba mengambil informasi Key Vault . 503 TooManyRequests - Permintaan di luar permintaan maks yang dapat diproses oleh sumber daya yang tersedia.

Contoh

Update the encryption protector to key vault

Update the encryption protector to service managed

Update the encryption protector to key vault

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/managedInstances/sqlcrudtest-4645/encryptionProtector/current?api-version=2021-11-01

{
  "properties": {
    "serverKeyType": "AzureKeyVault",
    "serverKeyName": "someVault_someKey_01234567890123456789012345678901",
    "autoRotationEnabled": false
  }
}

Java

import com.azure.core.util.Context;
import com.azure.resourcemanager.sql.fluent.models.ManagedInstanceEncryptionProtectorInner;
import com.azure.resourcemanager.sql.models.EncryptionProtectorName;
import com.azure.resourcemanager.sql.models.ServerKeyType;

/** Samples for ManagedInstanceEncryptionProtectors CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file: specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/
     * ManagedInstanceEncryptionProtectorCreateOrUpdateKeyVault.json
     */
    /**
     * Sample code: Update the encryption protector to key vault.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void updateTheEncryptionProtectorToKeyVault(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getManagedInstanceEncryptionProtectors().createOrUpdate(
            "sqlcrudtest-7398", "sqlcrudtest-4645", EncryptionProtectorName.CURRENT,
            new ManagedInstanceEncryptionProtectorInner().withServerKeyName("fakeTokenPlaceholder")
                .withServerKeyType(ServerKeyType.AZURE_KEY_VAULT).withAutoRotationEnabled(false),
            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

Sample Response

Status code:

200

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/managedInstances/sqlcrudtest-4645/encryptionProtector/current",
  "name": "current",
  "type": "Microsoft.Sql/managedInstances/encryptionProtector",
  "kind": "azurekeyvault",
  "properties": {
    "serverKeyName": "someVault_someKey_01234567890123456789012345678901",
    "serverKeyType": "AzureKeyVault",
    "autoRotationEnabled": false
  }
}

Status code:

202

Update the encryption protector to service managed

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/managedInstances/sqlcrudtest-4645/encryptionProtector/current?api-version=2021-11-01

{
  "properties": {
    "serverKeyType": "ServiceManaged",
    "serverKeyName": "ServiceManaged"
  }
}

Java

import com.azure.core.util.Context;
import com.azure.resourcemanager.sql.fluent.models.ManagedInstanceEncryptionProtectorInner;
import com.azure.resourcemanager.sql.models.EncryptionProtectorName;
import com.azure.resourcemanager.sql.models.ServerKeyType;

/** Samples for ManagedInstanceEncryptionProtectors CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file: specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/
     * ManagedInstanceEncryptionProtectorCreateOrUpdateServiceManaged.json
     */
    /**
     * Sample code: Update the encryption protector to service managed.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        updateTheEncryptionProtectorToServiceManaged(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getManagedInstanceEncryptionProtectors().createOrUpdate(
            "sqlcrudtest-7398", "sqlcrudtest-4645", EncryptionProtectorName.CURRENT,
            new ManagedInstanceEncryptionProtectorInner().withServerKeyName("fakeTokenPlaceholder")
                .withServerKeyType(ServerKeyType.SERVICE_MANAGED),
            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

Sample Response

Status code:

200

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/managedInstances/sqlcrudtest-4645/encryptionProtector/current",
  "name": "current",
  "type": "Microsoft.Sql/managedInstances/encryptionProtector",
  "kind": "servicemanaged",
  "properties": {
    "serverKeyName": "ServiceManaged",
    "serverKeyType": "ServiceManaged"
  }
}

Status code:

202

Definisi

Nama	Deskripsi
EncryptionProtectorName	Nama pelindung enkripsi yang akan diperbarui.
ManagedInstanceEncryptionProtector	Pelindung enkripsi instans terkelola.
ServerKeyType	Jenis pelindung enkripsi seperti 'ServiceManaged', 'AzureKeyVault'.

EncryptionProtectorName

Nama pelindung enkripsi yang akan diperbarui.

Nama	Jenis	Deskripsi
current	string

ManagedInstanceEncryptionProtector

Pelindung enkripsi instans terkelola.

Nama	Jenis	Deskripsi
id	string	ID Sumber Daya.
kind	string	Jenis pelindung enkripsi. Ini adalah metadata yang digunakan untuk pengalaman portal Azure.
name	string	Nama sumber daya.
properties.autoRotationEnabled	boolean	Bendera keikutsertaan rotasi otomatis kunci. Baik true maupun false.
properties.serverKeyName	string	Nama kunci instans terkelola.
properties.serverKeyType	ServerKeyType	Jenis pelindung enkripsi seperti 'ServiceManaged', 'AzureKeyVault'.
properties.thumbprint	string	Thumbprint kunci server.
properties.uri	string	URI kunci server.
type	string	Jenis sumber daya

ServerKeyType

Jenis pelindung enkripsi seperti 'ServiceManaged', 'AzureKeyVault'.

Nama	Jenis	Deskripsi
AzureKeyVault	string
ServiceManaged	string