Share via


Database.GetClientEncryptionKey(String) Method

Definition

Returns a reference to a client encryption key object. This method is not meant to be invoked directly. Please see https://aka.ms/CosmosClientEncryption in order to use client-side encryption.

public abstract Microsoft.Azure.Cosmos.ClientEncryptionKey GetClientEncryptionKey (string id);
abstract member GetClientEncryptionKey : string -> Microsoft.Azure.Cosmos.ClientEncryptionKey
Public MustOverride Function GetClientEncryptionKey (id As String) As ClientEncryptionKey

Parameters

id
String

Unique identifier for the client encryption key.

Returns

Client encryption key reference.

Remarks

The reference returned doesn't guarantee existence of the client encryption key. Please ensure it already exists or is created through CreateClientEncryptionKeyAsync(ClientEncryptionKeyProperties, RequestOptions, CancellationToken).

Applies to