你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

ClientEncryptionPolicy 类

定义

命名空间:

Microsoft.Azure.Cosmos

程序集:

Microsoft.Azure.Cosmos.Client.dll

包:

Microsoft.Azure.Cosmos v3.39.0

Source:

ClientEncryptionPolicy.cs

ClientEncryptionPolicy如果需要加密属于分区键的“id”属性或属性，则应使用 policyFormatVersion 2 和“确定性”加密类型初始化 。 所有分区键属性值都必须是 JSON 字符串。

public sealed class ClientEncryptionPolicy

type ClientEncryptionPolicy = class

Public NotInheritable Class ClientEncryptionPolicy

继承

Object

ClientEncryptionPolicy

示例

此示例演示如何创建 ClientEncryptionPolicy。

Collection<ClientEncryptionIncludedPath> paths = new Collection<ClientEncryptionIncludedPath>()
{
   new ClientEncryptionIncludedPath()
   {
       Path = partitionKeyPath,
       ClientEncryptionKeyId = "key1",
       EncryptionAlgorithm = "AEAD_AES_256_CBC_HMAC_SHA256",
       EncryptionType = "Deterministic"
   },
   new ClientEncryptionIncludedPath()
   {
       Path = "/id",
       ClientEncryptionKeyId = "key2",
       EncryptionAlgorithm = "AEAD_AES_256_CBC_HMAC_SHA256",
       EncryptionType = "Deterministic"
   },
};

ContainerProperties setting = new ContainerProperties()
{
   Id = containerName,
   PartitionKeyPath = partitionKeyPath,
   ClientEncryptionPolicy = new ClientEncryptionPolicy(includedPaths:paths, policyFormatVersion:2)
};

构造函数

ClientEncryptionPolicy(IEnumerable<ClientEncryptionIncludedPath>)	初始化 ClientEncryptionPolicy 类的新实例。 PolicyFormatVersion将 设置为 1。 注意：如果需要将分区键或 ID 字段路径作为 的一部分包含在 中 ClientEncryptionPolicy，请将 设置为 PolicyFormatVersion 2。
ClientEncryptionPolicy(IEnumerable<ClientEncryptionIncludedPath>, Int32)	初始化 ClientEncryptionPolicy 类的新实例。 注意：如果需要将分区键或 ID 字段路径作为 的一部分包含在 中 ClientEncryptionPolicy，请将 设置为 PolicyFormatVersion 2。

属性

IncludedPaths	需要加密的项的路径以及特定于路径的设置。
PolicyFormatVersion	客户端加密策略定义的版本。