次の方法で共有


Microsoft.DocumentDB databaseAccounts/sqlDatabases/clientEncryptionKeys 2024-08-15

Bicep リソース定義

databaseAccounts/sqlDatabases/clientEncryptionKeys リソースの種類は、次をターゲットとする操作でデプロイできます。

  • リソース グループの - リソース グループのデプロイ コマンド 参照

各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。

リソースの形式

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys リソースを作成するには、次の Bicep をテンプレートに追加します。

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys@2024-08-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 このクライアント暗号化キーと共に使用される暗号化アルゴリズムを使用して、データの暗号化と暗号化解除を行います。
身分証明書 ClientEncryptionKey の名前
keyWrapMetadata ラップされたクライアント暗号化キーのラップ解除に使用できるラッピング プロバイダーのメタデータ。 KeyWrapMetadata
wrappedDataEncryptionKey バイト配列として表されるキーのラップされた (暗号化された) 形式。 任意

KeyWrapMetadata

名前 形容 価値
アルゴリズム データ暗号化キーのラップとラップ解除に使用されるアルゴリズム。
名前 関連付けられている KeyEncryptionKey (別名 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-08-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 このクライアント暗号化キーと共に使用される暗号化アルゴリズムを使用して、データの暗号化と暗号化解除を行います。
身分証明書 ClientEncryptionKey の名前
keyWrapMetadata ラップされたクライアント暗号化キーのラップ解除に使用できるラッピング プロバイダーのメタデータ。 KeyWrapMetadata
wrappedDataEncryptionKey バイト配列として表されるキーのラップされた (暗号化された) 形式。 任意

KeyWrapMetadata

名前 形容 価値
アルゴリズム データ暗号化キーのラップとラップ解除に使用されるアルゴリズム。
名前 関連付けられている KeyEncryptionKey (別名 CustomerManagedKey) の名前。
種類 KeyStoreProvider の ProviderName。
価値 KeyEncryptionKey への参照/リンク。

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys

名前 形容 価値
apiVersion API のバージョン '2024-08-15'
名前 リソース名 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-08-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 このクライアント暗号化キーと共に使用される暗号化アルゴリズムを使用して、データの暗号化と暗号化解除を行います。
身分証明書 ClientEncryptionKey の名前
keyWrapMetadata ラップされたクライアント暗号化キーのラップ解除に使用できるラッピング プロバイダーのメタデータ。 KeyWrapMetadata
wrappedDataEncryptionKey バイト配列として表されるキーのラップされた (暗号化された) 形式。 任意

KeyWrapMetadata

名前 形容 価値
アルゴリズム データ暗号化キーのラップとラップ解除に使用されるアルゴリズム。
名前 関連付けられている KeyEncryptionKey (別名 CustomerManagedKey) の名前。
種類 KeyStoreProvider の ProviderName。
価値 KeyEncryptionKey への参照/リンク。

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys

名前 形容 価値
名前 リソース名 string (必須)
parent_id このリソースの親であるリソースの ID。 種類のリソースの ID: databaseAccounts/sqlDatabases
プロパティ ClientEncryptionKey を作成および更新するためのプロパティ。 ClientEncryptionKeyCreateUpdatePropertiesOrClientEncryptionKeyGetProperties (必須)
種類 リソースの種類 "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys@2024-08-15"