Package version:

Interface ClientEncryptionKeyProperties

Details of a client encryption key for use with the Azure Cosmos DB service.

interface ClientEncryptionKeyProperties {
    encryptionAlgorithm: string;
    encryptionKeyWrapMetadata: EncryptionKeyWrapMetadata;
    id: string;
    wrappedDataEncryptionKey: Uint8Array;
}

Properties

encryptionAlgorithm: string

Encryption algorithm that will be used along with this client encryption key to encrypt/decrypt data

encryptionKeyWrapMetadata: EncryptionKeyWrapMetadata

Metadata used to wrap/unwrap client encryption key using customer managed key.

id: string

unique identifier for the client encryption key

wrappedDataEncryptionKey: Uint8Array

Wrapped (encrypted) form of the client encryption key.