通过

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

Microsoft.DocumentDB databaseAccounts/sqlDatabases/clientEncryptionKeys

  • 项目

Bicep 资源定义

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

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

资源格式

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

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys@2024-12-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    resource: {
      encryptionAlgorithm: 'string'
      id: 'string'
      keyWrapMetadata: {
        algorithm: 'string'
        name: 'string'
        type: 'string'
        value: 'string'
      }
      wrappedDataEncryptionKey: any(Azure.Bicep.Types.Concrete.AnyType)
    }
  }
}

属性值

ClientEncryptionKeyCreateUpdatePropertiesOrClientEncryptionKeyGetProperties

名字 描述 价值
资源 ClientEncryptionKey 的标准 JSON 格式 ClientEncryptionKeyResourceOrClientEncryptionKeyGetPropertiesResource（必需）

ClientEncryptionKeyResourceOrClientEncryptionKeyGetPropertiesResource

名字 描述 价值
encryptionAlgorithm 将与此客户端加密密钥一起使用以加密/解密数据的加密算法。 字符串
id ClientEncryptionKey 的名称 字符串
keyWrapMetadata 包装提供程序的元数据，可用于解包包装的客户端加密密钥。 KeyWrapMetadata
wrappedDataEncryptionKey 表示为字节数组的密钥的包装（加密）形式。 任何

KeyWrapMetadata

名字 描述 价值
算法 用于包装和解包数据加密密钥的算法。 字符串
名字 关联的 KeyEncryptionKey（aka CustomerManagedKey）的名称。 字符串
类型 KeyStoreProvider 的 ProviderName。 字符串
价值 KeyEncryptionKey 的引用/链接。 字符串

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys

名字 描述 价值
名字 资源名称 string （必需）
父母 在 Bicep 中，可以为子资源指定父资源。 仅当子资源在父资源外部声明时，才需要添加此属性。

有关详细信息，请参阅 父资源外部的子资源。		 类型资源的符号名称：databaseAccounts/sqlDatabases
性能 用于创建和更新 ClientEncryptionKey 的属性。 ClientEncryptionKeyCreateUpdatePropertiesOrClientEncryptionKeyGetProperties （必需）

ARM 模板资源定义

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

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

资源格式

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

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

属性值

ClientEncryptionKeyCreateUpdatePropertiesOrClientEncryptionKeyGetProperties

名字 描述 价值
资源 ClientEncryptionKey 的标准 JSON 格式 ClientEncryptionKeyResourceOrClientEncryptionKeyGetPropertiesResource（必需）

ClientEncryptionKeyResourceOrClientEncryptionKeyGetPropertiesResource

名字 描述 价值
encryptionAlgorithm 将与此客户端加密密钥一起使用以加密/解密数据的加密算法。 字符串
id ClientEncryptionKey 的名称 字符串
keyWrapMetadata 包装提供程序的元数据，可用于解包包装的客户端加密密钥。 KeyWrapMetadata
wrappedDataEncryptionKey 表示为字节数组的密钥的包装（加密）形式。 任何

KeyWrapMetadata

名字 描述 价值
算法 用于包装和解包数据加密密钥的算法。 字符串
名字 关联的 KeyEncryptionKey（aka CustomerManagedKey）的名称。 字符串
类型 KeyStoreProvider 的 ProviderName。 字符串
价值 KeyEncryptionKey 的引用/链接。 字符串

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys

名字 描述 价值
apiVersion API 版本 '2024-12-01-preview'
名字 资源名称 string （必需）
性能 用于创建和更新 ClientEncryptionKey 的属性。 ClientEncryptionKeyCreateUpdatePropertiesOrClientEncryptionKeyGetProperties （必需）
类型 资源类型 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys'

Terraform （AzAPI 提供程序）资源定义

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

  • 资源组

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

资源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys@2024-12-01-preview"
  name = "string"
  body = jsonencode({
    properties = {
      resource = {
        encryptionAlgorithm = "string"
        id = "string"
        keyWrapMetadata = {
          algorithm = "string"
          name = "string"
          type = "string"
          value = "string"
        }
        wrappedDataEncryptionKey = ?
      }
    }
  })
}

属性值

ClientEncryptionKeyCreateUpdatePropertiesOrClientEncryptionKeyGetProperties

名字 描述 价值
资源 ClientEncryptionKey 的标准 JSON 格式 ClientEncryptionKeyResourceOrClientEncryptionKeyGetPropertiesResource（必需）

ClientEncryptionKeyResourceOrClientEncryptionKeyGetPropertiesResource

名字 描述 价值
encryptionAlgorithm 将与此客户端加密密钥一起使用以加密/解密数据的加密算法。 字符串
id ClientEncryptionKey 的名称 字符串
keyWrapMetadata 包装提供程序的元数据，可用于解包包装的客户端加密密钥。 KeyWrapMetadata
wrappedDataEncryptionKey 表示为字节数组的密钥的包装（加密）形式。 任何

KeyWrapMetadata

名字 描述 价值
算法 用于包装和解包数据加密密钥的算法。 字符串
名字 关联的 KeyEncryptionKey（aka CustomerManagedKey）的名称。 字符串
类型 KeyStoreProvider 的 ProviderName。 字符串
价值 KeyEncryptionKey 的引用/链接。 字符串

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys

名字 描述 价值
名字 资源名称 string （必需）
parent_id 此资源的父资源的 ID。 类型资源的 ID：databaseAccounts/sqlDatabases
性能 用于创建和更新 ClientEncryptionKey 的属性。 ClientEncryptionKeyCreateUpdatePropertiesOrClientEncryptionKeyGetProperties （必需）
类型 资源类型 “Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys@2024-12-01-preview”