CosmosDBSqlClientEncryptionKeyCollection.GetAsync 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.10
Source:
CosmosDBSqlClientEncryptionKeyCollection.cs
Source:
CosmosDBSqlClientEncryptionKeyCollection.cs

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-05-15-preview
  • Resource: CosmosDBSqlClientEncryptionKeyResource
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.CosmosDB.CosmosDBSqlClientEncryptionKeyResource>> GetAsync (string clientEncryptionKeyName, System.Threading.CancellationToken cancellationToken = default);
abstract member GetAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.CosmosDB.CosmosDBSqlClientEncryptionKeyResource>>
override this.GetAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.CosmosDB.CosmosDBSqlClientEncryptionKeyResource>>
Public Overridable Function GetAsync (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

ArgumentException

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

ArgumentNullException

clientEncryptionKeyName is null.

Applies to