Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
ClientEncryptionKeyProperties interface
- Package:
- @azure/cosmos
Details of a client encryption key for use with the Azure Cosmos DB service.
Properties
| encryptionAlgorithm | Encryption algorithm that will be used along with this client encryption key to encrypt/decrypt data |
| encryptionKeyWrapMetadata | Metadata used to wrap/unwrap client encryption key using customer managed key. |
| id | unique identifier for the client encryption key |
| wrappedDataEncryptionKey | Wrapped (encrypted) form of the client encryption key. |
Property Details
encryptionAlgorithm
Encryption algorithm that will be used along with this client encryption key to encrypt/decrypt data
encryptionAlgorithm: stringProperty Value
string
encryptionKeyWrapMetadata
Metadata used to wrap/unwrap client encryption key using customer managed key.
encryptionKeyWrapMetadata: EncryptionKeyWrapMetadataProperty Value
id
unique identifier for the client encryption key
id: stringProperty Value
string
wrappedDataEncryptionKey
Wrapped (encrypted) form of the client encryption key.
wrappedDataEncryptionKey: Uint8ArrayProperty Value
Uint8Array