Managed Instances - Validate Azure Key Vault Encryption Key

Layanan:

SQL Database

Versi API:

2025-01-01

Memvalidasi kunci yang dikelola pelanggan.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/validateAzureKeyVaultEncryptionKey?api-version=2025-01-01

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
managedInstanceName	path	True	string	Nama instans terkelola.
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 digunakan untuk operasi ini.

Isi Permintaan

Nama	Diperlukan	Jenis	Deskripsi
tdeKeyUri	True	string	URI kunci.

Respons

Nama	Jenis	Deskripsi
200 OK		Permintaan telah berhasil.
202 Accepted		Operasi sumber daya diterima. Header Location: string Retry-After: integer
Other Status Codes	ErrorResponse	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

Validate the customer managed key.

Permintaan sampel

HTTP

POST https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Sql/managedInstances/testinstance/validateAzureKeyVaultEncryptionKey?api-version=2025-01-01

{
  "tdeKeyUri": "https://someVault.vault.azure.net/keys/someKey/01234567890123456789012345678901"
}

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/SQL/stable/2025-01-01/examples/ManagedInstancValidateAzureKeyVaultEncryptionKey.json
// this example is just showing the usage of "ManagedInstances_ValidateAzureKeyVaultEncryptionKey" 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 ManagedInstanceResource created on azure
// for more information of creating ManagedInstanceResource, please refer to the document of ManagedInstanceResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "testrg";
string managedInstanceName = "testinstance";
ResourceIdentifier managedInstanceResourceId = ManagedInstanceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, managedInstanceName);
ManagedInstanceResource managedInstance = client.GetManagedInstanceResource(managedInstanceResourceId);

// invoke the operation
ManagedInstanceValidateAzureKeyVaultEncryptionKeyContent content = new ManagedInstanceValidateAzureKeyVaultEncryptionKeyContent(new Uri("https://someVault.vault.azure.net/keys/someKey/01234567890123456789012345678901"));
await managedInstance.ValidateAzureKeyVaultEncryptionKeyAsync(WaitUntil.Completed, content);

Console.WriteLine("Succeeded");

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

Kode status:

202

Azure-AsyncOperation: https://management.azure.com/subscriptions/f2669dff-5f08-45dd-b857-b2a60b72cdc9/providers/Microsoft.Sql/locations/japaneast/managedInstanceAzureAsyncOperation/00000000-1111-2222-3333-444444444444?api-version=2025-01-01
Location: https://management.azure.com/subscriptions/f2669dff-5f08-45dd-b857-b2a60b72cdc9/providers/Microsoft.Sql/locations/japaneast/managedInstanceOperationResults/00000000-1111-2222-3333-444444444444?api-version=2025-01-01

Definisi

Nama	Deskripsi
ErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
ErrorDetail	Detail kesalahan.
ErrorResponse	Tanggapan kesalahan
ManagedInstanceValidateAzureKeyVaultEncryptionKeyRequest	Validasi kunci enkripsi brankas kunci Azure.

ErrorAdditionalInfo

Objek

Info tambahan kesalahan manajemen sumber daya.

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

ErrorDetail

Objek

Detail kesalahan.

Nama	Jenis	Deskripsi
additionalInfo	ErrorAdditionalInfo[]	Info tambahan 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.

ManagedInstanceValidateAzureKeyVaultEncryptionKeyRequest

Objek

Validasi kunci enkripsi brankas kunci Azure.

Nama	Jenis	Deskripsi
tdeKeyUri	string	URI kunci.