Share via

ClientEncryptionPolicy interface

  • Reference
Package:
@azure/cosmos

Represents the client encryption policy associated with a container.

Properties

includedPaths

list of paths that needs to be encrypted along with their encryption settings.
policyFormatVersion

Version of the client encryption policy definition. The supported versions are 1 and 2. Default is 1. Id and partition key paths encryption are only supported in version 2.

Property Details

includedPaths

list of paths that needs to be encrypted along with their encryption settings.

includedPaths: ClientEncryptionIncludedPath[]

Property Value

ClientEncryptionIncludedPath[]

policyFormatVersion

Version of the client encryption policy definition. The supported versions are 1 and 2. Default is 1. Id and partition key paths encryption are only supported in version 2.

policyFormatVersion?: number

Property Value

number