Share via

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

  • 發行項

Bicep 資源定義

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

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

資源格式

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

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys@2021-11-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...

名稱 描述 值
資源 ClientEncryptionKey 的標準 JSON 格式 ClientEncryptionKeyResourceOrClientEncryptionKeyGetP... 必要 ()

ClientEncryptionKeyResourceOrClientEncryptionKeyGetP...

名稱 描述 值
encryptionAlgorithm 將與此用戶端加密金鑰一起使用的加密演算法，以加密/解密數據。 字串
id ClientEncryptionKey 的名稱 字串
keyWrapMetadata 包裝提供者的元數據，可用來解除包裝包裝的用戶端加密密鑰。 KeyWrapMetadata
wrappedDataEncryptionKey 包裝 (以位元組陣列表示之金鑰的加密) 形式。 針對 Bicep，您可以使用 任何 () 函式。

KeyWrapMetadata

名稱 描述 值
演算法 用於包裝和解除包裝數據加密密鑰的演算法。 字串
NAME 相關聯的 KeyEncryptionKey 名稱 (也稱為 CustomerManagedKey) 。 字串
type KeyStoreProvider 的 ProviderName。 字串
value KeyEncryptionKey 的參考 / 連結。 字串

ARM 範本資源定義

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

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

資源格式

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

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

屬性值

databaseAccounts/sqlDatabases/clientEncryptionKeys

名稱 描述 值
類型 資源類型 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys'
apiVersion 資源 API 版本 '2021-11-15-preview'
NAME 資源名稱

瞭解如何在 JSON ARM 範本中設定子資源的名稱和類型。		 需要字串 ()
properties 要建立及更新 ClientEncryptionKey 的屬性。 ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc... 必要 ()

ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc...

名稱 描述 值
資源 ClientEncryptionKey 的標準 JSON 格式 ClientEncryptionKeyResourceOrClientEncryptionKeyGetP... 必要 ()

ClientEncryptionKeyResourceOrClientEncryptionKeyGetP...

名稱 描述 值
encryptionAlgorithm 將與此用戶端加密金鑰一起使用的加密演算法，以加密/解密數據。 字串
id ClientEncryptionKey 的名稱 字串
keyWrapMetadata 包裝提供者的元數據，可用來解除包裝包裝的用戶端加密密鑰。 KeyWrapMetadata
wrappedDataEncryptionKey 包裝 (加密) 形式的金鑰，以位元組陣列表示。

KeyWrapMetadata

名稱 描述 值
演算法 用於包裝和解除包裝數據加密密鑰的演算法。 字串
NAME 相關聯的 KeyEncryptionKey 名稱 (也稱為 CustomerManagedKey) 。 字串
type KeyStoreProvider 的 ProviderName。 字串
value KeyEncryptionKey 的參考 /連結。 字串

Terraform (AzAPI 提供者) 資源定義

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

  • 資源群組

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

資源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys@2021-11-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

名稱 描述 值
類型 資源類型 “Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys@2021-11-15-preview”
NAME 資源名稱 需要字串 ()
parent_id 此資源父系之資源的標識碼。 類型資源的標識碼： sqlDatabases
properties 要建立及更新 ClientEncryptionKey 的屬性。 ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc... 必要 ()

ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc...

名稱 描述 值
資源 ClientEncryptionKey 的標準 JSON 格式 ClientEncryptionKeyResourceOrClientEncryptionKeyGetP... 必要 ()

ClientEncryptionKeyResourceOrClientEncryptionKeyGetP...

名稱 描述 值
encryptionAlgorithm 將與此用戶端加密金鑰一起使用的加密演算法，以加密/解密數據。 字串
id ClientEncryptionKey 的名稱 字串
keyWrapMetadata 包裝提供者的元數據，可用來解除包裝包裝的用戶端加密密鑰。 KeyWrapMetadata
wrappedDataEncryptionKey 包裝 (加密) 形式的金鑰，以位元組陣列表示。

KeyWrapMetadata

名稱 描述 值
演算法 用於包裝和解除包裝數據加密密鑰的演算法。 字串
NAME 相關聯的 KeyEncryptionKey 名稱 (也稱為 CustomerManagedKey) 。 字串
type KeyStoreProvider 的 ProviderName。 字串
value KeyEncryptionKey 的參考 /連結。 字串