共用方式為

Microsoft.DocumentDB 資料庫Accounts/sqlDatabases/clientEncryptionKeys 2024-11-15

  • 發行項

Bicep 資源定義

databaseAccounts/sqlDatabases/clientEncryptionKeys 資源類型可以使用目標作業來部署：

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys 資源，請將下列 Bicep 新增至範本。

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys@2024-11-15' = {
  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 名稱（也稱為 CustomerManagedKey）。 字串
類型 KeyStoreProvider 的 ProviderName。 字串
價值 KeyEncryptionKey 的參考/ 連結。 字串

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys

名字 描述 價值
名字 資源名稱 字串 （必要）
父母 在 Bicep 中，您可以指定子資源的父資源。 只有在父資源外部宣告子資源時，才需要新增這個屬性。

如需詳細資訊，請參閱 父資源外部的子資源。		 類型資源的符號名稱：databaseAccounts/sqlDatabases
性能 用來建立及更新 ClientEncryptionKey 的屬性。 ClientEncryptionKeyCreateUpdatePropertiesOrClientEncryptionKeyGetProperties （必要）

ARM 樣本資源定義

databaseAccounts/sqlDatabases/clientEncryptionKeys 資源類型可以使用目標作業來部署：

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys 資源，請將下列 JSON 新增至範本。

{
  "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys",
  "apiVersion": "2024-11-15",
  "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 名稱（也稱為 CustomerManagedKey）。 字串
類型 KeyStoreProvider 的 ProviderName。 字串
價值 KeyEncryptionKey 的參考/ 連結。 字串

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys

名字 描述 價值
apiVersion API 版本 '2024-11-15'
名字 資源名稱 字串 （必要）
性能 用來建立及更新 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-11-15"
  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 名稱（也稱為 CustomerManagedKey）。 字串
類型 KeyStoreProvider 的 ProviderName。 字串
價值 KeyEncryptionKey 的參考/ 連結。 字串

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys

名字 描述 價值
名字 資源名稱 字串 （必要）
parent_id 此資源為父系之資源的標識碼。 類型資源的標識碼：databaseAccounts/sqlDatabases
性能 用來建立及更新 ClientEncryptionKey 的屬性。 ClientEncryptionKeyCreateUpdatePropertiesOrClientEncryptionKeyGetProperties （必要）
類型 資源類型 “Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys@2024-11-15”