Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
ClientEncryptionIncludedPath interface
- Package:
- @azure/cosmos
Represents a path for encryption and its associated settings.
Properties
| clientEncryptionKeyId | identifier of the client encryption key to use to encrypt the path |
| encryptionAlgorithm | encryption algorithm to be used currently only AEAD_AES_256_CBC_HMAC_SHA256 algo is supported |
| encryptionType | type of encryption to be performed (Deterministic or Randomized) |
| path | name of the path to be encrypted |
Property Details
clientEncryptionKeyId
identifier of the client encryption key to use to encrypt the path
clientEncryptionKeyId: stringProperty Value
string
encryptionAlgorithm
encryption algorithm to be used currently only AEAD_AES_256_CBC_HMAC_SHA256 algo is supported
encryptionAlgorithm: AEAD_AES_256_CBC_HMAC_SHA256Property Value
encryptionType
type of encryption to be performed (Deterministic or Randomized)
encryptionType: EncryptionTypeProperty Value
path
name of the path to be encrypted
path: stringProperty Value
string