ClientEncryptionKey Class

Reference

Definition

Namespace:: Microsoft.Azure.Cosmos

Assembly:: Microsoft.Azure.Cosmos.Client.dll

Package:: Microsoft.Azure.Cosmos v3.39.0

Source:: ClientEncryptionKey.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.

Provides operations for reading a specific client data encryption key (aka ClientEncryptionKey) by Id. See Database for operations to create and enumerate client encryption keys. See https://aka.ms/CosmosClientEncryption for more information on client-side encryption support in Azure Cosmos DB.

public abstract class ClientEncryptionKey

type ClientEncryptionKey = class

Public MustInherit Class ClientEncryptionKey

Inheritance: Object
ClientEncryptionKey

Constructors

ClientEncryptionKey()

Properties

Id	The unique identifier of the client encryption key.

Methods

ReadAsync(RequestOptions, CancellationToken)	Reads the properties of a client encryption key from the Azure Cosmos service as an asynchronous operation. This method is not meant to be invoked directly. Please see https://aka.ms/CosmosClientEncryption in order to use client-side encryption.
ReplaceAsync(ClientEncryptionKeyProperties, RequestOptions, CancellationToken)	Replace a ClientEncryptionKeyProperties from the Azure Cosmos service as an asynchronous operation. This method is not meant to be invoked directly. Please see https://aka.ms/CosmosClientEncryption in order to use client-side encryption.

Applies to