C# Class Microsoft.Azure.Cosmos.ClientEncryptionPolicy

显示文件 Open project: Azure/azure-cosmos-dotnet-v3 Class Usage Examples

Private Properties

Property	Type	Description
ClientEncryptionPolicy	System
ValidateClientEncryptionIncludedPath	void
ValidateIncludedPaths	void
ValidatePartitionKeyPathsIfEncrypted	void

Public Methods

Method	Description
ClientEncryptionPolicy ( IEnumerable includedPaths ) : System	Initializes a new instance of the ClientEncryptionPolicy class. The PolicyFormatVersion will be set to 1. Note: If you need to include partition key or id field paths as part of ClientEncryptionPolicy, please set PolicyFormatVersion to 2.
ClientEncryptionPolicy ( IEnumerable includedPaths, int policyFormatVersion ) : System	Initializes a new instance of the ClientEncryptionPolicy class. Note: If you need to include partition key or id field paths as part of ClientEncryptionPolicy, please set PolicyFormatVersion to 2.

Private Methods

Method	Description
ClientEncryptionPolicy ( ) : System
ValidateClientEncryptionIncludedPath ( Microsoft.Azure.Cosmos.ClientEncryptionIncludedPath clientEncryptionIncludedPath, int policyFormatVersion ) : void
ValidateIncludedPaths ( IEnumerable clientEncryptionIncludedPath, int policyFormatVersion ) : void
ValidatePartitionKeyPathsIfEncrypted ( IReadOnlyList partitionKeyPathTokens ) : void	Ensures that partition key paths specified in the client encryption policy for encryption are encrypted using Deterministic encryption algorithm.

Method Details

ClientEncryptionPolicy() public method

Initializes a new instance of the ClientEncryptionPolicy class. The PolicyFormatVersion will be set to 1. Note: If you need to include partition key or id field paths as part of ClientEncryptionPolicy, please set PolicyFormatVersion to 2.

public ClientEncryptionPolicy ( IEnumerable includedPaths ) : System
includedPaths	IEnumerable	List of paths to include in the policy definition.
return	System

ClientEncryptionPolicy() public method

Initializes a new instance of the ClientEncryptionPolicy class. Note: If you need to include partition key or id field paths as part of ClientEncryptionPolicy, please set PolicyFormatVersion to 2.

public ClientEncryptionPolicy ( IEnumerable includedPaths, int policyFormatVersion ) : System
includedPaths	IEnumerable	List of paths to include in the policy definition.
policyFormatVersion	int	Version of the client encryption policy definition. Current supported versions are 1 and 2.
return	System