Managed Instances - Validate Azure Key Vault Encryption Key

Služba:

SQL Database

Verze rozhraní API:

2025-01-01

Ověří klíč spravovaný zákazníkem.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
managedInstanceName	path	True	string	Název spravované instance.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
subscriptionId	path	True	string (uuid)	ID cílového předplatného. Hodnota musí být UUID.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Text požadavku

Name	Vyžadováno	Typ	Description
tdeKeyUri	True	string	Identifikátor URI klíče.

Odpovědi

Name	Typ	Description
200 OK		Požadavek byl úspěšný.
202 Accepted		Operace prostředku byla přijata. Hlavičky Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Neočekávaná chybová odpověď

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

Validate the customer managed key.

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:

200

Stavový kód:

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

Definice

Name	Description
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Chybová odpověď
ManagedInstanceValidateAzureKeyVaultEncryptionKeyRequest	Ověřte šifrovací klíč trezoru klíčů Azure.

ErrorAdditionalInfo

Objekt

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorDetail

Objekt

Podrobnosti o chybě.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorResponse

Objekt

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

ManagedInstanceValidateAzureKeyVaultEncryptionKeyRequest

Objekt

Ověřte šifrovací klíč trezoru klíčů Azure.

Name	Typ	Description
tdeKeyUri	string	Identifikátor URI klíče.