Managed Instance Keys - Create Or Update

Membuat atau memperbarui kunci instans terkelola.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/keys/{keyName}?api-version=2022-02-01-preview

Parameter URI

Name In Required Type Description
keyName
path True
  • string

Nama kunci instans terkelola yang akan dioperasikan (diperbarui atau dibuat).

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

Name Required Type Description
properties.serverKeyType True

Jenis kunci seperti 'ServiceManaged', 'AzureKeyVault'.

properties.uri
  • string

URI kunci. Jika ServerKeyType adalah AzureKeyVault, maka URI diperlukan.

Respons

Name Type Description
200 OK

Berhasil memperbarui kunci instans terkelola.

201 Created

Berhasil membuat kunci instans terkelola.

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 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 Kesalahan Perwakilan Layanan pustaka Azure Active Directory tidak ditemukan.

  • 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.

  • 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.

  • 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 .

Contoh

Creates or updates a managed instance key

Sample Request

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/managedInstances/sqlcrudtest-4645/keys/someVault_someKey_01234567890123456789012345678901?api-version=2022-02-01-preview

{
  "properties": {
    "serverKeyType": "AzureKeyVault",
    "uri": "https://someVault.vault.azure.net/keys/someKey/01234567890123456789012345678901"
  }
}

Sample Response

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/managedInstances/sqlcrudtest-4645/keys/someVault_someKey_01234567890123456789012345678901",
  "name": "sqlcrudtest-4645",
  "type": "Microsoft.Sql/managedInstances/keys",
  "kind": "azurekeyvault",
  "properties": {
    "thumbprint": "00112233445566778899AABBCCDDEEFFAABBCCDD",
    "creationDate": "2020-11-01T00:00:00Z",
    "autoRotationEnabled": false
  }
}
{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/managedInstances/sqlcrudtest-4645/keys/someVault_someKey_01234567890123456789012345678901",
  "name": "sqlcrudtest-4645",
  "type": "Microsoft.Sql/managedInstances/keys",
  "kind": "azurekeyvault",
  "properties": {
    "thumbprint": "00112233445566778899AABBCCDDEEFFAABBCCDD",
    "creationDate": "2020-11-01T00:00:00Z",
    "autoRotationEnabled": false
  }
}

Definisi

ManagedInstanceKey

Kunci instans terkelola.

ServerKeyType

Jenis kunci seperti 'ServiceManaged', 'AzureKeyVault'.

ManagedInstanceKey

Kunci instans terkelola.

Name Type Description
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.creationDate
  • string

Tanggal pembuatan kunci.

properties.serverKeyType

Jenis kunci seperti 'ServiceManaged', 'AzureKeyVault'.

properties.thumbprint
  • string

Thumbprint kunci.

properties.uri
  • string

URI kunci. Jika ServerKeyType adalah AzureKeyVault, maka URI diperlukan.

type
  • string

Jenis sumber daya

ServerKeyType

Jenis kunci seperti 'ServiceManaged', 'AzureKeyVault'.

Name Type Description
AzureKeyVault
  • string
ServiceManaged
  • string