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

Microsoft.DocumentDB databaseAccounts/sqlDatabases/clientEncryptionKeys 2023-03-15-preview

• 最新
• 2024-05-15
• 2024-05-15-preview
• 2024-02-15-preview
• 2023-11-15
• 2023-11-15-preview
• 2023-09-15
• 2023-09-15-preview
• 2023-04-15
• 2023 年 3 月 15 日
• 2023-03-15-preview
• 2023-03-01-preview
• 2022-11-15
• 2022-11-15-preview
• 2022-08-15-preview
• 2022-05-15-preview
• 2022-02-15-preview
• 2021-11-15-preview
• 2021-10-15-preview

Bicep 资源定义

databaseAccounts/sqlDatabases/clientEncryptionKeys 资源类型可以使用目标操作进行部署：

• 资源组 - 请参阅 资源组部署命令

有关每个 API 版本中更改的属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys 资源，请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys@2023-03-15-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    resource: {
      encryptionAlgorithm: 'string'
      id: 'string'
      keyWrapMetadata: {
        algorithm: 'string'
        name: 'string'
        type: 'string'
        value: 'string'
      }
      wrappedDataEncryptionKey: any()
    }
  }
}

属性值

databaseAccounts/sqlDatabases/clientEncryptionKeys

名称	说明	值
name	资源名称 了解如何在 Bicep 中为子资源设置名称和类型。	字符串 (必需)
父级 (parent)	在 Bicep 中，可以为子资源指定父资源。 仅当子资源在父资源外部声明时，才需要添加此属性。 有关详细信息，请参阅 父资源之外的子资源。	类型为的资源的符号名称： sqlDatabases
properties	用于创建和更新 ClientEncryptionKey 的属性。	ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc... 所需的 ()

ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc...

名称	说明	值
resource	ClientEncryptionKey 的标准 JSON 格式	ClientEncryptionKeyResourceOrClientEncryptionKeyGetP... 所需的 ()

ClientEncryptionKeyResourceOrClientEncryptionKeyGetP...

名称	说明	值
encryptionAlgorithm	将与此客户端加密密钥一起使用的加密算法来加密/解密数据。	string
id	ClientEncryptionKey 的名称	字符串
keyWrapMetadata	包装提供程序的元数据，可用于解包已包装的客户端加密密钥。	KeyWrapMetadata
wrappedDataEncryptionKey	包装 (加密) 表示为字节数组的密钥形式。	对于 Bicep，可以使用 任何 () 函数。

KeyWrapMetadata

名称	说明	值
算法	用于包装和解包数据加密密钥的算法。	字符串
name	关联的 KeyEncryptionKey 的名称 (也称为 CustomerManagedKey) 。	字符串
type	KeyStoreProvider 的 ProviderName。	string
value	KeyEncryptionKey 的引用/链接。	字符串

ARM 模板资源定义

databaseAccounts/sqlDatabases/clientEncryptionKeys 资源类型可以使用目标操作进行部署：

• 资源组 - 请参阅 资源组部署命令

有关每个 API 版本中更改的属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys 资源，请将以下 JSON 添加到模板。

{
  "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys",
  "apiVersion": "2023-03-15-preview",
  "name": "string",
  "properties": {
    "resource": {
      "encryptionAlgorithm": "string",
      "id": "string",
      "keyWrapMetadata": {
        "algorithm": "string",
        "name": "string",
        "type": "string",
        "value": "string"
      },
      "wrappedDataEncryptionKey": {}
    }
  }
}

属性值

databaseAccounts/sqlDatabases/clientEncryptionKeys

名称	说明	Value
type	资源类型	'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys'
apiVersion	资源 API 版本	“2023-03-15-preview”
name	资源名称 了解如何在 JSON ARM 模板中为子资源设置名称和类型。	字符串 (必需)
properties	用于创建和更新 ClientEncryptionKey 的属性。	ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc... 所需的 ()

ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc...

名称	说明	值
resource	ClientEncryptionKey 的标准 JSON 格式	ClientEncryptionKeyResourceOrClientEncryptionKeyGetP... 所需的 ()

ClientEncryptionKeyResourceOrClientEncryptionKeyGetP...

名称	说明	值
encryptionAlgorithm	将与此客户端加密密钥一起使用的加密算法来加密/解密数据。	string
id	ClientEncryptionKey 的名称	字符串
keyWrapMetadata	包装提供程序的元数据，可用于解包已包装的客户端加密密钥。	KeyWrapMetadata
wrappedDataEncryptionKey	包装 (加密) 表示为字节数组的密钥形式。

KeyWrapMetadata

名称	说明	值
算法	用于包装和解包数据加密密钥的算法。	字符串
name	关联的 KeyEncryptionKey 的名称 (也称为 CustomerManagedKey) 。	字符串
type	KeyStoreProvider 的 ProviderName。	string
value	KeyEncryptionKey 的引用/链接。	字符串

Terraform (AzAPI 提供程序) 资源定义

databaseAccounts/sqlDatabases/clientEncryptionKeys 资源类型可以使用目标操作进行部署：

• 资源组

有关每个 API 版本中更改的属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys 资源，请将以下 Terraform 添加到模板。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys@2023-03-15-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      resource = {
        encryptionAlgorithm = "string"
        id = "string"
        keyWrapMetadata = {
          algorithm = "string"
          name = "string"
          type = "string"
          value = "string"
        }
      }
    }
  })
}

属性值

databaseAccounts/sqlDatabases/clientEncryptionKeys

名称	说明	Value
type	资源类型	“Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys@2023-03-15-preview”
name	资源名称	字符串 (必需)
parent_id	此资源的父资源 ID。	类型为：sqlDatabases 的资源的 ID
properties	用于创建和更新 ClientEncryptionKey 的属性。	ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc... 所需的 ()

ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc...

名称	说明	值
resource	ClientEncryptionKey 的标准 JSON 格式	ClientEncryptionKeyResourceOrClientEncryptionKeyGetP... 所需的 ()

ClientEncryptionKeyResourceOrClientEncryptionKeyGetP...

名称	说明	值
encryptionAlgorithm	将与此客户端加密密钥一起使用的加密算法来加密/解密数据。	string
id	ClientEncryptionKey 的名称	字符串
keyWrapMetadata	包装提供程序的元数据，可用于解包已包装的客户端加密密钥。	KeyWrapMetadata
wrappedDataEncryptionKey	包装 (加密) 表示为字节数组的密钥形式。

KeyWrapMetadata

名称	说明	值
算法	用于包装和解包数据加密密钥的算法。	字符串
name	关联的 KeyEncryptionKey 的名称 (也称为 CustomerManagedKey) 。	字符串
type	KeyStoreProvider 的 ProviderName。	string
value	KeyEncryptionKey 的引用/链接。	字符串