次の方法で共有


Microsoft.DocumentDB データベースアカウント/sqlデータベース/コンテナ 2024-05-15-preview

Bicep リソース定義

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

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

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

リソースの形式

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

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2024-05-15-preview' = {
  parent: resourceSymbolicName
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  ___location: 'string'
  name: 'string'
  properties: {
    options: {
      autoscaleSettings: {
        maxThroughput: int
      }
      throughput: int
    }
    resource: {
      analyticalStorageTtl: int
      clientEncryptionPolicy: {
        includedPaths: [
          {
            clientEncryptionKeyId: 'string'
            encryptionAlgorithm: 'string'
            encryptionType: 'string'
            path: 'string'
          }
        ]
        policyFormatVersion: int
      }
      computedProperties: [
        {
          name: 'string'
          query: 'string'
        }
      ]
      conflictResolutionPolicy: {
        conflictResolutionPath: 'string'
        conflictResolutionProcedure: 'string'
        mode: 'string'
      }
      createMode: 'string'
      defaultTtl: int
      id: 'string'
      indexingPolicy: {
        automatic: bool
        compositeIndexes: [
          [
            {
              order: 'string'
              path: 'string'
            }
          ]
        ]
        excludedPaths: [
          {
            path: 'string'
          }
        ]
        includedPaths: [
          {
            indexes: [
              {
                dataType: 'string'
                kind: 'string'
                precision: int
              }
            ]
            path: 'string'
          }
        ]
        indexingMode: 'string'
        spatialIndexes: [
          {
            path: 'string'
            types: [
              'string'
            ]
          }
        ]
      }
      materializedViewDefinition: {
        definition: 'string'
        sourceCollectionId: 'string'
      }
      partitionKey: {
        kind: 'string'
        paths: [
          'string'
        ]
        version: int
      }
      restoreParameters: {
        restoreSource: 'string'
        restoreTimestampInUtc: 'string'
        restoreWithTtlDisabled: bool
      }
      uniqueKeyPolicy: {
        uniqueKeys: [
          {
            paths: [
              'string'
            ]
          }
        ]
      }
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

プロパティ値

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers

名前 形容 価値
同一性 リソースの ID。 ManagedServiceIdentity の
場所 リソースが属するリソース グループの場所。
名前 リソース名 string (必須)
Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。

詳細については、「親リソースの外部 子リソース」を参照してください。
種類のリソースのシンボリック名: databaseAccounts/sqlDatabases
プロパティ Azure Cosmos DB コンテナーを作成および更新するためのプロパティ。 SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties (必須)
タグ リソース タグ タグ名と値のディクショナリ。 テンプレート の タグを参照してください

Autoscale設定

名前 形容 価値
最大スループット リソースをスケールアップできる最大スループットを表します。 整数 (int)

クライアント暗号化含まれるパス

名前 形容 価値
clientEncryptionKeyId (クライアント暗号化キー ID) パスの暗号化に使用するクライアント暗号化キーの識別子。 string (必須)
暗号化アルゴリズム 使用される暗号化アルゴリズム。 例: AEAD_AES_256_CBC_HMAC_SHA256。 string (必須)
暗号化タイプ 実行する暗号化の種類。 例 : 決定論的、ランダム化。 string (必須)
パス 暗号化する必要があるパス。 string (必須)

クライアント暗号化ポリシー

名前 形容 価値
includedパス パス固有の設定と共に暗号化が必要な項目のパス。 ClientEncryptionIncludedPath[] (必須)
policyFormatVersion (ポリシーフォーマットバージョン) クライアント暗号化ポリシー定義のバージョン。 サポートされているバージョンは 1 と 2 です。 バージョン 2 では、ID とパーティション キーパスの暗号化がサポートされています。 int

制約:
最小値 = 1
最大値 = 2 (必須)

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

名前 形容 価値

コンポジットパス

名前 形容 価値
命令 複合パスの並べ替え順序。 「昇順」
「降順」
パス インデックス作成の動作が適用されるパス。 インデックス パスは通常、ルートで始まり、ワイルドカード (/path/*) で終わる

コンピューテッドプロパティ

名前 形容 価値
名前 計算されたプロパティの名前 (例: "cp_lowerName"
クエリ 計算されたプロパティの値を評価するクエリ (例: "SELECT VALUE LOWER(c.name) FROM c"

ConflictResolutionPolicy (競合解決ポリシー)

名前 形容 価値
conflictResolutionPath (英語) LastWriterWins モードの場合の競合解決パス。
conflictResolutionProcedure カスタム モードの場合の競合を解決する手順。
モード 競合解決モードを示します。 「カスタム」
「ラストライターウィンズ」

コンテナパーティションキー

名前 形容 価値
種類 パーティション分割に使用されるアルゴリズムの種類を示します。 MultiHash の場合、コンテナーの作成では複数のパーティション キー (最大 3 つ) がサポートされます 「ハッシュ」
「マルチハッシュ」
「範囲」
パス コンテナー内のどのデータをパーティション分割できるかを使用するパスの一覧 文字列[]
バージョン パーティション キー定義のバージョンを示します int

制約:
最小値 = 1
最大値 = 2

CreateUpdateOptionsまたはSqlContainerGetPropertiesOptions

名前 形容 価値
自動スケール設定 自動スケール設定を指定します。 注: スループットまたは自動scaleSettingsは必須ですが、両方は必要ありません。 Autoscale設定
スループット 1 秒あたりの要求ユニット数。 たとえば、"throughput": 10000 です。 整数 (int)

除外パス

名前 形容 価値
パス インデックス作成の動作が適用されるパス。 インデックス パスは通常、ルートで始まり、ワイルドカード (/path/*) で終わる

インクルードパス

名前 形容 価値
索引 このパスのインデックスの一覧 インデックス[]
パス インデックス作成の動作が適用されるパス。 インデックス パスは通常、ルートで始まり、ワイルドカード (/path/*) で終わる

索引

名前 形容 価値
データタイプ インデックス作成の動作が適用されるデータ型。 'ラインストリング'
「マルチポリゴン」
'数値'
「ポイント」
「ポリゴン」
'文字列'
種類 インデックスの種類を示します。 「ハッシュ」
「範囲」
「空間的」
精度 インデックスの有効桁数。 -1 は最大有効桁数です。 整数 (int)

インデックス作成ポリシー

名前 形容 価値
自動 インデックス作成ポリシーが自動かどうかを示します ブール (bool)
コンポジットインデックス 複合パス リストの一覧 コンポジットパス[][]
excludedPaths (除外パス) インデックス作成から除外するパスの一覧 ExcludedPath[] を する
includedパス インデックス作成に含めるパスの一覧 含まれるパス[]
インデックスモード(indexingMode) インデックス作成モードを示します。 「一貫性」
「怠惰」
「なし」
空間インデックス 空間の詳細の一覧 SpatialSpec[]

マネージドサービスアイデンティティ

名前 形容 価値
種類 リソースに使用される ID の種類。 型 'SystemAssigned,UserAssigned' には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。 型 'None' は、サービスからすべての ID を削除します。 「なし」
'システム割り当て'
'システム割り当て済み、ユーザー割り当て済み'
'UserAssigned'
userAssignedIdentities (ユーザー割り当て済みアイデンティティ) リソースに関連付けられているユーザー ID の一覧。 ユーザー ID ディクショナリ のキー参照は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' という形式の ARM リソース ID になります。 ManagedServiceIdentityUserAssignedIdentities の

ManagedServiceIdentityUserAssignedIdentities

名前 形容 価値

MaterializedViewDefinition (マテリアライズドビュー定義)

名前 形容 価値
定義 定義は、ソース コンテナーからデータをフェッチして具体化されたビュー コンテナーにデータを取り込むのに使用される SQL クエリである必要があります。 string (必須)
sourceCollectionId (ソースコレクションID) 具体化されたビューが作成されるソース コンテナーの名前。 string (必須)

リソース復元パラメーター

名前 形容 価値
リストアソース 復元を開始する必要がある復元可能なデータベース アカウントの ID。 例: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{___location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}
restoreTimestampInUTCの アカウントを復元する必要がある時間 (ISO-8601 形式)。
restoreWithTtlDisabled (英語) 復元が成功した時点で、復元されたアカウントに Time-To-Live を無効にするかどうかを指定します。 ブール (bool)

SpatialSpec (空間スペック)

名前 形容 価値
パス インデックス作成の動作が適用されるパス。 インデックス パスは通常、ルートで始まり、ワイルドカード (/path/*) で終わる
種類 パスの空間型の一覧 次のいずれかを含む文字列配列:
'ラインストリング'
「マルチポリゴン」
「ポイント」
「ポリゴン」

SqlContainerCreateUpdatePropertiesまたはSqlContainerGetProperties

名前 形容 価値
オプション 要求に適用するオプションのキーと値のペア。 これは、要求と共に送信されたヘッダーに対応します。 CreateUpdateOptionsOrSqlContainerGetPropertiesOptions の
資源 コンテナーの標準 JSON 形式 SqlContainerResourceOrSqlContainerGetPropertiesResource (必須)

SqlContainerResourceまたはSqlContainerGetPropertiesResource

名前 形容 価値
analyticalStorageTtl 分析 TTL。 整数 (int)
クライアント暗号化ポリシー コンテナーのクライアント暗号化ポリシー。 クライアント暗号化ポリシー
computedプロパティ 計算プロパティの一覧 計算済みプロパティ[]
conflictResolutionPolicy(コンフリクトレゾリューションポリシー) コンテナーの競合解決ポリシー。 ConflictResolutionPolicy (競合解決ポリシー)
クリエイトモード リソースの作成モードを示す列挙型。 デフォルト
「復元」
デフォルトTtl 既定の有効期間 整数 (int)
身分証明書 Cosmos DB SQL コンテナーの名前 string (必須)
インデックスポリシー(いんでっくすいんぐ インデックス作成ポリシーの構成。 既定では、コンテナー内のすべてのドキュメント パスに対してインデックス作成が自動的に行われます。 インデックス作成ポリシー
materializedViewDefinition 具体化されたビューを定義するための構成。 これは、具体化されたビュー コンテナーを作成する場合にのみ指定する必要があります。 MaterializedViewDefinition (マテリアライズドビュー定義)
パーティションキー 複数のパーティションにデータをパーティション分割するために使用するパーティション キーの構成 コンテナパーティションキー
restoreParameters (リストアパラメータ) 復元に関する情報を示すパラメーター リソース復元パラメーター
uniqueKeyPolicy (ユニークキーポリシー) Azure Cosmos DB サービス内のコレクション内のドキュメントに対する一意性制約を指定するための一意キー ポリシー構成。 ユニークキーポリシー

タグ

名前 形容 価値

ユニークキー

名前 形容 価値
パス パスの一覧は、Azure Cosmos DB サービスのドキュメントごとに一意である必要があります 文字列[]

ユニークキーポリシー

名前 形容 価値
uniqueKeys(ユニークキー) Azure Cosmos DB サービスのコレクション内のドキュメントに一意性制約を適用する一意キーの一覧。 ユニークキー[]

使用例

Azure クイック スタートのサンプル

Azure クイック スタート テンプレート、このリソースの種類をデプロイするための Bicep サンプルが含まれています。

Bicep ファイル 形容
分析ストア を使用して Azure Cosmos DB アカウント SQL API を する このテンプレートは、分析ストアで構成されたデータベースとコンテナーを使用して、Core (SQL) API 用の Azure Cosmos アカウントを作成します。
Free レベルの Azure Cosmos DB アカウント を作成する このテンプレートは、共有スループットとコンテナーを持つデータベースを使用して、SQL API 用の Free レベルの Azure Cosmos DB アカウントを作成します。
Core (SQL) API 用の Azure Cosmos DB アカウントを作成する このテンプレートでは、他の複数のオプションを含むスループットを持つデータベースとコンテナーを使用して、コア (SQL) API 用の Azure Cosmos アカウントを作成します。
自動スケール を使用して Azure Cosmos DB アカウント SQL API を作成する このテンプレートでは、他の複数のオプションを使用して、自動スケーリング スループットを使用するデータベースとコンテナーを使用して、Core (SQL) API 用の Azure Cosmos アカウントを作成します。
Azure Cosmos DB Core (SQL) API ストアド プロシージャを作成 このテンプレートでは、Core (SQL) API 用の Azure Cosmos DB アカウントと、ストアド プロシージャ、トリガー、およびユーザー定義関数を含むコンテナーが作成されます。
Container Apps を使用して Dapr マイクロサービス アプリを作成する Container Apps を使用して Dapr マイクロサービス アプリを作成します。
Container Apps を使用して Dapr pub-sub servicebus アプリを作成します Container Apps を使用して Dapr pub-sub servicebus アプリを作成します。
Cosmos DB 接続 を使用して Azure Data Explorer DB をデプロイする Cosmos DB 接続を使用して Azure Data Explorer DB をデプロイします。

ARM テンプレート リソース定義

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

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

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

リソースの形式

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

{
  "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers",
  "apiVersion": "2024-05-15-preview",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "___location": "string",
  "properties": {
    "options": {
      "autoscaleSettings": {
        "maxThroughput": "int"
      },
      "throughput": "int"
    },
    "resource": {
      "analyticalStorageTtl": "int",
      "clientEncryptionPolicy": {
        "includedPaths": [
          {
            "clientEncryptionKeyId": "string",
            "encryptionAlgorithm": "string",
            "encryptionType": "string",
            "path": "string"
          }
        ],
        "policyFormatVersion": "int"
      },
      "computedProperties": [
        {
          "name": "string",
          "query": "string"
        }
      ],
      "conflictResolutionPolicy": {
        "conflictResolutionPath": "string",
        "conflictResolutionProcedure": "string",
        "mode": "string"
      },
      "createMode": "string",
      "defaultTtl": "int",
      "id": "string",
      "indexingPolicy": {
        "automatic": "bool",
        "compositeIndexes": [
          [
            {
              "order": "string",
              "path": "string"
            }
          ]
        ],
        "excludedPaths": [
          {
            "path": "string"
          }
        ],
        "includedPaths": [
          {
            "indexes": [
              {
                "dataType": "string",
                "kind": "string",
                "precision": "int"
              }
            ],
            "path": "string"
          }
        ],
        "indexingMode": "string",
        "spatialIndexes": [
          {
            "path": "string",
            "types": [ "string" ]
          }
        ]
      },
      "materializedViewDefinition": {
        "definition": "string",
        "sourceCollectionId": "string"
      },
      "partitionKey": {
        "kind": "string",
        "paths": [ "string" ],
        "version": "int"
      },
      "restoreParameters": {
        "restoreSource": "string",
        "restoreTimestampInUtc": "string",
        "restoreWithTtlDisabled": "bool"
      },
      "uniqueKeyPolicy": {
        "uniqueKeys": [
          {
            "paths": [ "string" ]
          }
        ]
      }
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

プロパティ値

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers

名前 形容 価値
apiVersion (英語) API のバージョン 「2024-05-15-プレビュー」
同一性 リソースの ID。 ManagedServiceIdentity の
場所 リソースが属するリソース グループの場所。
名前 リソース名 string (必須)
プロパティ Azure Cosmos DB コンテナーを作成および更新するためのプロパティ。 SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties (必須)
タグ リソース タグ タグ名と値のディクショナリ。 テンプレート の タグを参照してください
種類 リソースの種類 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers'

Autoscale設定

名前 形容 価値
最大スループット リソースをスケールアップできる最大スループットを表します。 整数 (int)

クライアント暗号化含まれるパス

名前 形容 価値
clientEncryptionKeyId (クライアント暗号化キー ID) パスの暗号化に使用するクライアント暗号化キーの識別子。 string (必須)
暗号化アルゴリズム 使用される暗号化アルゴリズム。 例: AEAD_AES_256_CBC_HMAC_SHA256。 string (必須)
暗号化タイプ 実行する暗号化の種類。 例 : 決定論的、ランダム化。 string (必須)
パス 暗号化する必要があるパス。 string (必須)

クライアント暗号化ポリシー

名前 形容 価値
includedパス パス固有の設定と共に暗号化が必要な項目のパス。 ClientEncryptionIncludedPath[] (必須)
policyFormatVersion (ポリシーフォーマットバージョン) クライアント暗号化ポリシー定義のバージョン。 サポートされているバージョンは 1 と 2 です。 バージョン 2 では、ID とパーティション キーパスの暗号化がサポートされています。 int

制約:
最小値 = 1
最大値 = 2 (必須)

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

名前 形容 価値

コンポジットパス

名前 形容 価値
命令 複合パスの並べ替え順序。 「昇順」
「降順」
パス インデックス作成の動作が適用されるパス。 インデックス パスは通常、ルートで始まり、ワイルドカード (/path/*) で終わる

コンピューテッドプロパティ

名前 形容 価値
名前 計算されたプロパティの名前 (例: "cp_lowerName"
クエリ 計算されたプロパティの値を評価するクエリ (例: "SELECT VALUE LOWER(c.name) FROM c"

ConflictResolutionPolicy (競合解決ポリシー)

名前 形容 価値
conflictResolutionPath (英語) LastWriterWins モードの場合の競合解決パス。
conflictResolutionProcedure カスタム モードの場合の競合を解決する手順。
モード 競合解決モードを示します。 「カスタム」
「ラストライターウィンズ」

コンテナパーティションキー

名前 形容 価値
種類 パーティション分割に使用されるアルゴリズムの種類を示します。 MultiHash の場合、コンテナーの作成では複数のパーティション キー (最大 3 つ) がサポートされます 「ハッシュ」
「マルチハッシュ」
「範囲」
パス コンテナー内のどのデータをパーティション分割できるかを使用するパスの一覧 文字列[]
バージョン パーティション キー定義のバージョンを示します int

制約:
最小値 = 1
最大値 = 2

CreateUpdateOptionsまたはSqlContainerGetPropertiesOptions

名前 形容 価値
自動スケール設定 自動スケール設定を指定します。 注: スループットまたは自動scaleSettingsは必須ですが、両方は必要ありません。 Autoscale設定
スループット 1 秒あたりの要求ユニット数。 たとえば、"throughput": 10000 です。 整数 (int)

除外パス

名前 形容 価値
パス インデックス作成の動作が適用されるパス。 インデックス パスは通常、ルートで始まり、ワイルドカード (/path/*) で終わる

インクルードパス

名前 形容 価値
索引 このパスのインデックスの一覧 インデックス[]
パス インデックス作成の動作が適用されるパス。 インデックス パスは通常、ルートで始まり、ワイルドカード (/path/*) で終わる

索引

名前 形容 価値
データタイプ インデックス作成の動作が適用されるデータ型。 'ラインストリング'
「マルチポリゴン」
'数値'
「ポイント」
「ポリゴン」
'文字列'
種類 インデックスの種類を示します。 「ハッシュ」
「範囲」
「空間的」
精度 インデックスの有効桁数。 -1 は最大有効桁数です。 整数 (int)

インデックス作成ポリシー

名前 形容 価値
自動 インデックス作成ポリシーが自動かどうかを示します ブール (bool)
コンポジットインデックス 複合パス リストの一覧 コンポジットパス[][]
excludedPaths (除外パス) インデックス作成から除外するパスの一覧 ExcludedPath[] を する
includedパス インデックス作成に含めるパスの一覧 含まれるパス[]
インデックスモード(indexingMode) インデックス作成モードを示します。 「一貫性」
「怠惰」
「なし」
空間インデックス 空間の詳細の一覧 SpatialSpec[]

マネージドサービスアイデンティティ

名前 形容 価値
種類 リソースに使用される ID の種類。 型 'SystemAssigned,UserAssigned' には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。 型 'None' は、サービスからすべての ID を削除します。 「なし」
'システム割り当て'
'システム割り当て済み、ユーザー割り当て済み'
'UserAssigned'
userAssignedIdentities (ユーザー割り当て済みアイデンティティ) リソースに関連付けられているユーザー ID の一覧。 ユーザー ID ディクショナリ のキー参照は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' という形式の ARM リソース ID になります。 ManagedServiceIdentityUserAssignedIdentities の

ManagedServiceIdentityUserAssignedIdentities

名前 形容 価値

MaterializedViewDefinition (マテリアライズドビュー定義)

名前 形容 価値
定義 定義は、ソース コンテナーからデータをフェッチして具体化されたビュー コンテナーにデータを取り込むのに使用される SQL クエリである必要があります。 string (必須)
sourceCollectionId (ソースコレクションID) 具体化されたビューが作成されるソース コンテナーの名前。 string (必須)

リソース復元パラメーター

名前 形容 価値
リストアソース 復元を開始する必要がある復元可能なデータベース アカウントの ID。 例: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{___location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}
restoreTimestampInUTCの アカウントを復元する必要がある時間 (ISO-8601 形式)。
restoreWithTtlDisabled (英語) 復元が成功した時点で、復元されたアカウントに Time-To-Live を無効にするかどうかを指定します。 ブール (bool)

SpatialSpec (空間スペック)

名前 形容 価値
パス インデックス作成の動作が適用されるパス。 インデックス パスは通常、ルートで始まり、ワイルドカード (/path/*) で終わる
種類 パスの空間型の一覧 次のいずれかを含む文字列配列:
'ラインストリング'
「マルチポリゴン」
「ポイント」
「ポリゴン」

SqlContainerCreateUpdatePropertiesまたはSqlContainerGetProperties

名前 形容 価値
オプション 要求に適用するオプションのキーと値のペア。 これは、要求と共に送信されたヘッダーに対応します。 CreateUpdateOptionsOrSqlContainerGetPropertiesOptions の
資源 コンテナーの標準 JSON 形式 SqlContainerResourceOrSqlContainerGetPropertiesResource (必須)

SqlContainerResourceまたはSqlContainerGetPropertiesResource

名前 形容 価値
analyticalStorageTtl 分析 TTL。 整数 (int)
クライアント暗号化ポリシー コンテナーのクライアント暗号化ポリシー。 クライアント暗号化ポリシー
computedプロパティ 計算プロパティの一覧 計算済みプロパティ[]
conflictResolutionPolicy(コンフリクトレゾリューションポリシー) コンテナーの競合解決ポリシー。 ConflictResolutionPolicy (競合解決ポリシー)
クリエイトモード リソースの作成モードを示す列挙型。 デフォルト
「復元」
デフォルトTtl 既定の有効期間 整数 (int)
身分証明書 Cosmos DB SQL コンテナーの名前 string (必須)
インデックスポリシー(いんでっくすいんぐ インデックス作成ポリシーの構成。 既定では、コンテナー内のすべてのドキュメント パスに対してインデックス作成が自動的に行われます。 インデックス作成ポリシー
materializedViewDefinition 具体化されたビューを定義するための構成。 これは、具体化されたビュー コンテナーを作成する場合にのみ指定する必要があります。 MaterializedViewDefinition (マテリアライズドビュー定義)
パーティションキー 複数のパーティションにデータをパーティション分割するために使用するパーティション キーの構成 コンテナパーティションキー
restoreParameters (リストアパラメータ) 復元に関する情報を示すパラメーター リソース復元パラメーター
uniqueKeyPolicy (ユニークキーポリシー) Azure Cosmos DB サービス内のコレクション内のドキュメントに対する一意性制約を指定するための一意キー ポリシー構成。 ユニークキーポリシー

タグ

名前 形容 価値

ユニークキー

名前 形容 価値
パス パスの一覧は、Azure Cosmos DB サービスのドキュメントごとに一意である必要があります 文字列[]

ユニークキーポリシー

名前 形容 価値
uniqueKeys(ユニークキー) Azure Cosmos DB サービスのコレクション内のドキュメントに一意性制約を適用する一意キーの一覧。 ユニークキー[]

使用例

Azure クイック スタート テンプレート

このリソースの種類 デプロイする Azure クイック スタート テンプレート 次に示します。

テンプレート 形容
分析ストア を使用して Azure Cosmos DB アカウント SQL API を する

Azure
にデプロイする
このテンプレートは、分析ストアで構成されたデータベースとコンテナーを使用して、Core (SQL) API 用の Azure Cosmos アカウントを作成します。
Free レベルの Azure Cosmos DB アカウント を作成する

Azure にデプロイする
このテンプレートは、共有スループットとコンテナーを持つデータベースを使用して、SQL API 用の Free レベルの Azure Cosmos DB アカウントを作成します。
Core (SQL) API 用の Azure Cosmos DB アカウントを作成する

Azure にデプロイする
このテンプレートでは、他の複数のオプションを含むスループットを持つデータベースとコンテナーを使用して、コア (SQL) API 用の Azure Cosmos アカウントを作成します。
自動スケール を使用して Azure Cosmos DB アカウント SQL API を作成する

Azure にデプロイする
このテンプレートでは、他の複数のオプションを使用して、自動スケーリング スループットを使用するデータベースとコンテナーを使用して、Core (SQL) API 用の Azure Cosmos アカウントを作成します。
Azure Cosmos DB Core (SQL) API ストアド プロシージャを作成

Azure にデプロイする
このテンプレートでは、Core (SQL) API 用の Azure Cosmos DB アカウントと、ストアド プロシージャ、トリガー、およびユーザー定義関数を含むコンテナーが作成されます。
Container Apps を使用して Dapr マイクロサービス アプリを作成する

Azure にデプロイする
Container Apps を使用して Dapr マイクロサービス アプリを作成します。
Container Apps を使用して Dapr pub-sub servicebus アプリを作成します

Azure にデプロイする
Container Apps を使用して Dapr pub-sub servicebus アプリを作成します。
Cosmos DB 接続 を使用して Azure Data Explorer DB をデプロイする

Azure にデプロイする
Cosmos DB 接続を使用して Azure Data Explorer DB をデプロイします。

Terraform (AzAPI プロバイダー) リソース定義

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

  • リソース グループの

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

リソースの形式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2024-05-15-preview"
  name = "string"
  parent_id = "string"
  identity {
    type = "string"
    identity_ids = [
      "string"
    ]
  }
  ___location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      options = {
        autoscaleSettings = {
          maxThroughput = int
        }
        throughput = int
      }
      resource = {
        analyticalStorageTtl = int
        clientEncryptionPolicy = {
          includedPaths = [
            {
              clientEncryptionKeyId = "string"
              encryptionAlgorithm = "string"
              encryptionType = "string"
              path = "string"
            }
          ]
          policyFormatVersion = int
        }
        computedProperties = [
          {
            name = "string"
            query = "string"
          }
        ]
        conflictResolutionPolicy = {
          conflictResolutionPath = "string"
          conflictResolutionProcedure = "string"
          mode = "string"
        }
        createMode = "string"
        defaultTtl = int
        id = "string"
        indexingPolicy = {
          automatic = bool
          compositeIndexes = [
            [
              {
                order = "string"
                path = "string"
              }
            ]
          ]
          excludedPaths = [
            {
              path = "string"
            }
          ]
          includedPaths = [
            {
              indexes = [
                {
                  dataType = "string"
                  kind = "string"
                  precision = int
                }
              ]
              path = "string"
            }
          ]
          indexingMode = "string"
          spatialIndexes = [
            {
              path = "string"
              types = [
                "string"
              ]
            }
          ]
        }
        materializedViewDefinition = {
          definition = "string"
          sourceCollectionId = "string"
        }
        partitionKey = {
          kind = "string"
          paths = [
            "string"
          ]
          version = int
        }
        restoreParameters = {
          restoreSource = "string"
          restoreTimestampInUtc = "string"
          restoreWithTtlDisabled = bool
        }
        uniqueKeyPolicy = {
          uniqueKeys = [
            {
              paths = [
                "string"
              ]
            }
          ]
        }
      }
    }
  }
}

プロパティ値

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers

名前 形容 価値
同一性 リソースの ID。 ManagedServiceIdentity の
場所 リソースが属するリソース グループの場所。
名前 リソース名 string (必須)
parent_id このリソースの親であるリソースの ID。 種類のリソースの ID: databaseAccounts/sqlDatabases
プロパティ Azure Cosmos DB コンテナーを作成および更新するためのプロパティ。 SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties (必須)
タグ リソース タグ タグ名と値のディクショナリ。
種類 リソースの種類 "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2024-05-15-preview" (英語)

Autoscale設定

名前 形容 価値
最大スループット リソースをスケールアップできる最大スループットを表します。 整数 (int)

クライアント暗号化含まれるパス

名前 形容 価値
clientEncryptionKeyId (クライアント暗号化キー ID) パスの暗号化に使用するクライアント暗号化キーの識別子。 string (必須)
暗号化アルゴリズム 使用される暗号化アルゴリズム。 例: AEAD_AES_256_CBC_HMAC_SHA256。 string (必須)
暗号化タイプ 実行する暗号化の種類。 例 : 決定論的、ランダム化。 string (必須)
パス 暗号化する必要があるパス。 string (必須)

クライアント暗号化ポリシー

名前 形容 価値
includedパス パス固有の設定と共に暗号化が必要な項目のパス。 ClientEncryptionIncludedPath[] (必須)
policyFormatVersion (ポリシーフォーマットバージョン) クライアント暗号化ポリシー定義のバージョン。 サポートされているバージョンは 1 と 2 です。 バージョン 2 では、ID とパーティション キーパスの暗号化がサポートされています。 int

制約:
最小値 = 1
最大値 = 2 (必須)

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

名前 形容 価値

コンポジットパス

名前 形容 価値
命令 複合パスの並べ替え順序。 「昇順」
「降順」
パス インデックス作成の動作が適用されるパス。 インデックス パスは通常、ルートで始まり、ワイルドカード (/path/*) で終わる

コンピューテッドプロパティ

名前 形容 価値
名前 計算されたプロパティの名前 (例: "cp_lowerName"
クエリ 計算されたプロパティの値を評価するクエリ (例: "SELECT VALUE LOWER(c.name) FROM c"

ConflictResolutionPolicy (競合解決ポリシー)

名前 形容 価値
conflictResolutionPath (英語) LastWriterWins モードの場合の競合解決パス。
conflictResolutionProcedure カスタム モードの場合の競合を解決する手順。
モード 競合解決モードを示します。 「カスタム」
「ラストライターウィンズ」

コンテナパーティションキー

名前 形容 価値
種類 パーティション分割に使用されるアルゴリズムの種類を示します。 MultiHash の場合、コンテナーの作成では複数のパーティション キー (最大 3 つ) がサポートされます 「ハッシュ」
「マルチハッシュ」
「範囲」
パス コンテナー内のどのデータをパーティション分割できるかを使用するパスの一覧 文字列[]
バージョン パーティション キー定義のバージョンを示します int

制約:
最小値 = 1
最大値 = 2

CreateUpdateOptionsまたはSqlContainerGetPropertiesOptions

名前 形容 価値
自動スケール設定 自動スケール設定を指定します。 注: スループットまたは自動scaleSettingsは必須ですが、両方は必要ありません。 Autoscale設定
スループット 1 秒あたりの要求ユニット数。 たとえば、"throughput": 10000 です。 整数 (int)

除外パス

名前 形容 価値
パス インデックス作成の動作が適用されるパス。 インデックス パスは通常、ルートで始まり、ワイルドカード (/path/*) で終わる

インクルードパス

名前 形容 価値
索引 このパスのインデックスの一覧 インデックス[]
パス インデックス作成の動作が適用されるパス。 インデックス パスは通常、ルートで始まり、ワイルドカード (/path/*) で終わる

索引

名前 形容 価値
データタイプ インデックス作成の動作が適用されるデータ型。 'ラインストリング'
「マルチポリゴン」
'数値'
「ポイント」
「ポリゴン」
'文字列'
種類 インデックスの種類を示します。 「ハッシュ」
「範囲」
「空間的」
精度 インデックスの有効桁数。 -1 は最大有効桁数です。 整数 (int)

インデックス作成ポリシー

名前 形容 価値
自動 インデックス作成ポリシーが自動かどうかを示します ブール (bool)
コンポジットインデックス 複合パス リストの一覧 コンポジットパス[][]
excludedPaths (除外パス) インデックス作成から除外するパスの一覧 ExcludedPath[] を する
includedパス インデックス作成に含めるパスの一覧 含まれるパス[]
インデックスモード(indexingMode) インデックス作成モードを示します。 「一貫性」
「怠惰」
「なし」
空間インデックス 空間の詳細の一覧 SpatialSpec[]

マネージドサービスアイデンティティ

名前 形容 価値
種類 リソースに使用される ID の種類。 型 'SystemAssigned,UserAssigned' には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。 型 'None' は、サービスからすべての ID を削除します。 「なし」
'システム割り当て'
'システム割り当て済み、ユーザー割り当て済み'
'UserAssigned'
userAssignedIdentities (ユーザー割り当て済みアイデンティティ) リソースに関連付けられているユーザー ID の一覧。 ユーザー ID ディクショナリ のキー参照は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' という形式の ARM リソース ID になります。 ManagedServiceIdentityUserAssignedIdentities の

ManagedServiceIdentityUserAssignedIdentities

名前 形容 価値

MaterializedViewDefinition (マテリアライズドビュー定義)

名前 形容 価値
定義 定義は、ソース コンテナーからデータをフェッチして具体化されたビュー コンテナーにデータを取り込むのに使用される SQL クエリである必要があります。 string (必須)
sourceCollectionId (ソースコレクションID) 具体化されたビューが作成されるソース コンテナーの名前。 string (必須)

リソース復元パラメーター

名前 形容 価値
リストアソース 復元を開始する必要がある復元可能なデータベース アカウントの ID。 例: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{___location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}
restoreTimestampInUTCの アカウントを復元する必要がある時間 (ISO-8601 形式)。
restoreWithTtlDisabled (英語) 復元が成功した時点で、復元されたアカウントに Time-To-Live を無効にするかどうかを指定します。 ブール (bool)

SpatialSpec (空間スペック)

名前 形容 価値
パス インデックス作成の動作が適用されるパス。 インデックス パスは通常、ルートで始まり、ワイルドカード (/path/*) で終わる
種類 パスの空間型の一覧 次のいずれかを含む文字列配列:
'ラインストリング'
「マルチポリゴン」
「ポイント」
「ポリゴン」

SqlContainerCreateUpdatePropertiesまたはSqlContainerGetProperties

名前 形容 価値
オプション 要求に適用するオプションのキーと値のペア。 これは、要求と共に送信されたヘッダーに対応します。 CreateUpdateOptionsOrSqlContainerGetPropertiesOptions の
資源 コンテナーの標準 JSON 形式 SqlContainerResourceOrSqlContainerGetPropertiesResource (必須)

SqlContainerResourceまたはSqlContainerGetPropertiesResource

名前 形容 価値
analyticalStorageTtl 分析 TTL。 整数 (int)
クライアント暗号化ポリシー コンテナーのクライアント暗号化ポリシー。 クライアント暗号化ポリシー
computedプロパティ 計算プロパティの一覧 計算済みプロパティ[]
conflictResolutionPolicy(コンフリクトレゾリューションポリシー) コンテナーの競合解決ポリシー。 ConflictResolutionPolicy (競合解決ポリシー)
クリエイトモード リソースの作成モードを示す列挙型。 デフォルト
「復元」
デフォルトTtl 既定の有効期間 整数 (int)
身分証明書 Cosmos DB SQL コンテナーの名前 string (必須)
インデックスポリシー(いんでっくすいんぐ インデックス作成ポリシーの構成。 既定では、コンテナー内のすべてのドキュメント パスに対してインデックス作成が自動的に行われます。 インデックス作成ポリシー
materializedViewDefinition 具体化されたビューを定義するための構成。 これは、具体化されたビュー コンテナーを作成する場合にのみ指定する必要があります。 MaterializedViewDefinition (マテリアライズドビュー定義)
パーティションキー 複数のパーティションにデータをパーティション分割するために使用するパーティション キーの構成 コンテナパーティションキー
restoreParameters (リストアパラメータ) 復元に関する情報を示すパラメーター リソース復元パラメーター
uniqueKeyPolicy (ユニークキーポリシー) Azure Cosmos DB サービス内のコレクション内のドキュメントに対する一意性制約を指定するための一意キー ポリシー構成。 ユニークキーポリシー

タグ

名前 形容 価値

ユニークキー

名前 形容 価値
パス パスの一覧は、Azure Cosmos DB サービスのドキュメントごとに一意である必要があります 文字列[]

ユニークキーポリシー

名前 形容 価値
uniqueKeys(ユニークキー) Azure Cosmos DB サービスのコレクション内のドキュメントに一意性制約を適用する一意キーの一覧。 ユニークキー[]