CosmosDBSqlClientEncryptionKeyCollection.Get Method
Definition
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. : ClientEncryptionKeyGetResultsOperationGroup_GetClientEncryptionKey.
- Default Api Version. : 2026-03-15.
public virtual Azure.Response<Azure.ResourceManager.CosmosDB.CosmosDBSqlClientEncryptionKeyResource> Get(string clientEncryptionKeyName, System.Threading.CancellationToken cancellationToken = default);abstract member Get : string * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.CosmosDB.CosmosDBSqlClientEncryptionKeyResource>
override this.Get : string * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.CosmosDB.CosmosDBSqlClientEncryptionKeyResource>Public Overridable Function Get (clientEncryptionKeyName As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of CosmosDBSqlClientEncryptionKeyResource)Parameters
- clientEncryptionKeyName
- String
Cosmos DB ClientEncryptionKey name.
- cancellationToken
- CancellationToken
The cancellation token to use.
Returns
Exceptions
clientEncryptionKeyName is null.
clientEncryptionKeyName is an empty string, and was expected to be non-empty.
