ClientEncryptionKeyResource interface

Cosmos DB client encryption key resource object.

Properties

encryptionAlgorithm

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

id

Name of the ClientEncryptionKey

keyWrapMetadata

Metadata for the wrapping provider that can be used to unwrap the wrapped client encryption key.

wrappedDataEncryptionKey

Wrapped (encrypted) form of the key represented as a byte array.

Property Details

encryptionAlgorithm

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

encryptionAlgorithm?: string

Property Value

string

id

Name of the ClientEncryptionKey

id?: string

Property Value

string

keyWrapMetadata

Metadata for the wrapping provider that can be used to unwrap the wrapped client encryption key.

keyWrapMetadata?: KeyWrapMetadata

Property Value

wrappedDataEncryptionKey

Wrapped (encrypted) form of the key represented as a byte array.

wrappedDataEncryptionKey?: Uint8Array

Property Value

Uint8Array