CosmosDBSqlDatabaseResource.GetCosmosDBSqlClientEncryptionKeyAsync Method

Reference

Definition

Namespace:: Azure.ResourceManager.CosmosDB

Assembly:: Azure.ResourceManager.CosmosDB.dll

Package:: Azure.ResourceManager.CosmosDB v1.3.2

Package:: Azure.ResourceManager.CosmosDB v1.4.0-beta.11

Source:: CosmosDBSqlDatabaseResource.cs

Source:: CosmosDBSqlDatabaseResource.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets the ClientEncryptionKey under an existing Azure Cosmos DB SQL database.

Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/clientEncryptionKeys/{clientEncryptionKeyName}
Operation Id: SqlResources_GetClientEncryptionKey
Default Api Version: 2024-09-01-preview
Resource: CosmosDBSqlClientEncryptionKeyResource

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.CosmosDB.CosmosDBSqlClientEncryptionKeyResource>> GetCosmosDBSqlClientEncryptionKeyAsync (string clientEncryptionKeyName, System.Threading.CancellationToken cancellationToken = default);

abstract member GetCosmosDBSqlClientEncryptionKeyAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.CosmosDB.CosmosDBSqlClientEncryptionKeyResource>>
override this.GetCosmosDBSqlClientEncryptionKeyAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.CosmosDB.CosmosDBSqlClientEncryptionKeyResource>>

Public Overridable Function GetCosmosDBSqlClientEncryptionKeyAsync (clientEncryptionKeyName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of CosmosDBSqlClientEncryptionKeyResource))

Parameters

clientEncryptionKeyName: String

Cosmos DB ClientEncryptionKey name.

cancellationToken: CancellationToken

The cancellation token to use.

Returns

Task<Response<CosmosDBSqlClientEncryptionKeyResource>>

Exceptions

ArgumentNullException

clientEncryptionKeyName is null.

ArgumentException

clientEncryptionKeyName is an empty string, and was expected to be non-empty.

Applies to

Share via