Microsoft.DocumentDB databaseAccounts/sqlDatabases/containers

• 最新の を する
• 2024-12-01-preview
• 2024-11-15
• 2024-09-01-preview
• 2024-08-15
• 2024-05-15
• 2024-05-15-preview
• 2024-02-15-preview
• 2023-11-15
• 2023-11-15-preview
• 2023-09-15
• 2023-09-15-preview
• 2023-04-15
• 2023-03-15
• 2023-03-15-preview
• 2023-03-01-preview
• 2022-11-15
• 2022-11-15-preview
• 2022-08-15
• 2022-08-15-preview
• 2022-05-15
• 2022-05-15-preview
• 2022-02-15-preview
• 2021-11-15-preview
• 2021-10-15
• 2021-10-15-preview
• 2021-07-01-preview
• 2021-06-15
• 2021-05-15
• 2021-04-15
• 2021-04-01-preview
• 2021-03-15
• 2021-03-01-preview
• 2021-01-15
• 2020-09-01
• 2020-06-01-preview
• 2020-04-01
• 2020-03-01
• 2019-12-12
• 2019-08-01

Bicep リソース定義

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

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

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

リソースの形式

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

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2024-12-01-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'
            ]
          }
        ]
        vectorIndexes: [
          {
            path: 'string'
            type: 'string'
          }
        ]
      }
      materializedViewDefinition: {
        definition: 'string'
        sourceCollectionId: 'string'
      }
      partitionKey: {
        kind: 'string'
        paths: [
          'string'
        ]
        version: int
      }
      restoreParameters: {
        restoreSource: 'string'
        restoreTimestampInUtc: 'string'
        restoreWithTtlDisabled: bool
      }
      uniqueKeyPolicy: {
        uniqueKeys: [
          {
            paths: [
              'string'
            ]
          }
        ]
      }
      vectorEmbeddingPolicy: {
        vectorEmbeddings: [
          {
            dataType: 'string'
            dimensions: int
            distanceFunction: 'string'
            path: 'string'
          }
        ]
      }
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

プロパティ値

AutoscaleSettings

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

ClientEncryptionIncludedPath

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

ClientEncryptionPolicy

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

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

名前	形容	価値

CompositePath

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

ComputedProperty

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

ConflictResolutionPolicy

名前	形容	価値
conflictResolutionPath	LastWriterWins モードの場合の競合解決パス。	糸
conflictResolutionProcedure	カスタム モードの場合の競合を解決する手順。	糸
モード	競合解決モードを示します。	'Custom' 'LastWriterWins'

ContainerPartitionKey

名前	形容	価値
種類	パーティション分割に使用されるアルゴリズムの種類を示します。 MultiHash の場合、コンテナーの作成では複数のパーティション キー (最大 3 つ) がサポートされます	'Hash' 'MultiHash' 'Range'
パス	コンテナー内のどのデータをパーティション分割できるかを使用するパスの一覧	string[]
バージョン	パーティション キー定義のバージョンを示します	int 制約： 最小値 = 1 最大値 = 2

CreateUpdateOptionsOrSqlContainerGetPropertiesOptions

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

ExcludedPath

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

IncludedPath

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

索引

名前	形容	価値
dataType	インデックス作成の動作が適用されるデータ型。	'LineString' 'MultiPolygon' 'Number' 'Point' 'Polygon' 'String'
種類	インデックスの種類を示します。	'Hash' 'Range' 'Spatial'
精度	インデックスの有効桁数。 -1 は最大有効桁数です。	int

IndexingPolicy

名前	形容	価値
自動	インデックス作成ポリシーが自動かどうかを示します	bool
compositeIndexes	複合パス リストの一覧	CompositePath[][]
excludedPaths	インデックス作成から除外するパスの一覧	ExcludedPath[] を する
includedPaths	インデックス作成に含めるパスの一覧	IncludedPath[]
indexingMode	インデックス作成モードを示します。	'consistent' 'lazy' 'none'
spatialIndexes	空間の詳細の一覧	SpatialSpec[]
vectorIndexes	ベクター インデックス作成に含めるパスの一覧	VectorIndex[]

ManagedServiceIdentity

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

ManagedServiceIdentityUserAssignedIdentities

名前	形容	価値

MaterializedViewDefinition

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

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers

名前	形容	価値
同一性	リソースの ID。	ManagedServiceIdentity の
場所	リソースが属するリソース グループの場所。	糸
名前	リソース名	string (必須)
親	Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。 詳細については、「親リソースの外部 子リソース」を参照してください。	種類のリソースのシンボリック名: databaseAccounts/sqlDatabases
プロパティ	Azure Cosmos DB コンテナーを作成および更新するためのプロパティ。	SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties (必須)
タグ	リソース タグ	タグ名と値のディクショナリ。 テンプレート の タグを参照してください

ResourceRestoreParameters

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

SpatialSpec

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

SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties

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

SqlContainerResourceOrSqlContainerGetPropertiesResource

名前	形容	価値
analyticalStorageTtl	分析 TTL。	int
clientEncryptionPolicy	コンテナーのクライアント暗号化ポリシー。	ClientEncryptionPolicy
computedProperties	計算プロパティの一覧	ComputedProperty[]
conflictResolutionPolicy	コンテナーの競合解決ポリシー。	ConflictResolutionPolicy
createMode	リソースの作成モードを示す列挙型。	'Default' 'Restore'
defaultTtl	既定の有効期間	int
身分証明書	Cosmos DB SQL コンテナーの名前	string (必須)
indexingPolicy	インデックス作成ポリシーの構成。 既定では、コンテナー内のすべてのドキュメント パスに対してインデックス作成が自動的に行われます。	IndexingPolicy
materializedViewDefinition	具体化されたビューを定義するための構成。 これは、具体化されたビュー コンテナーを作成する場合にのみ指定する必要があります。	MaterializedViewDefinition
partitionKey	複数のパーティションにデータをパーティション分割するために使用するパーティション キーの構成	ContainerPartitionKey
restoreParameters	復元に関する情報を示すパラメーター	ResourceRestoreParameters
uniqueKeyPolicy	Azure Cosmos DB サービス内のコレクション内のドキュメントに対する一意性制約を指定するための一意キー ポリシー構成。	UniqueKeyPolicy
vectorEmbeddingPolicy	コンテナーのベクター埋め込みポリシー。	VectorEmbeddingPolicy の

タグ

名前	形容	価値

UniqueKey

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

UniqueKeyPolicy

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

VectorEmbedding

名前	形容	価値
dataType	ベクターのデータ型を示します。	'float32' 'int8' 'uint8' (必須)
寸法	ベクトル内の次元の数。	int (必須)
distanceFunction	ベクトル間の距離計算に使用する距離関数。	'cosine' 'dotproduct' 'euclidean' (必須)
パス	ドキュメント内のベクター フィールドへのパス。	string (必須)

VectorEmbeddingPolicy

名前	形容	価値
vectorEmbeddings	ベクター埋め込みの一覧	VectorEmbedding[]

VectorIndex

名前	形容	価値
パス	ドキュメント内のベクター フィールドへのパス。	string (必須)
種類	ベクターのインデックス型。 現在、フラット、diskANN、およびクオンタイズフラットがサポートされています。	'diskANN' 'flat' 'quantizedFlat' (必須)

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

次のクイック スタート サンプルでは、このリソースの種類をデプロイします。

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-12-01-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" ]
          }
        ],
        "vectorIndexes": [
          {
            "path": "string",
            "type": "string"
          }
        ]
      },
      "materializedViewDefinition": {
        "definition": "string",
        "sourceCollectionId": "string"
      },
      "partitionKey": {
        "kind": "string",
        "paths": [ "string" ],
        "version": "int"
      },
      "restoreParameters": {
        "restoreSource": "string",
        "restoreTimestampInUtc": "string",
        "restoreWithTtlDisabled": "bool"
      },
      "uniqueKeyPolicy": {
        "uniqueKeys": [
          {
            "paths": [ "string" ]
          }
        ]
      },
      "vectorEmbeddingPolicy": {
        "vectorEmbeddings": [
          {
            "dataType": "string",
            "dimensions": "int",
            "distanceFunction": "string",
            "path": "string"
          }
        ]
      }
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

プロパティ値

AutoscaleSettings

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

ClientEncryptionIncludedPath

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

ClientEncryptionPolicy

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

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

名前	形容	価値

CompositePath

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

ComputedProperty

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

ConflictResolutionPolicy

名前	形容	価値
conflictResolutionPath	LastWriterWins モードの場合の競合解決パス。	糸
conflictResolutionProcedure	カスタム モードの場合の競合を解決する手順。	糸
モード	競合解決モードを示します。	'Custom' 'LastWriterWins'

ContainerPartitionKey

名前	形容	価値
種類	パーティション分割に使用されるアルゴリズムの種類を示します。 MultiHash の場合、コンテナーの作成では複数のパーティション キー (最大 3 つ) がサポートされます	'Hash' 'MultiHash' 'Range'
パス	コンテナー内のどのデータをパーティション分割できるかを使用するパスの一覧	string[]
バージョン	パーティション キー定義のバージョンを示します	int 制約： 最小値 = 1 最大値 = 2

CreateUpdateOptionsOrSqlContainerGetPropertiesOptions

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

ExcludedPath

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

IncludedPath

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

索引

名前	形容	価値
dataType	インデックス作成の動作が適用されるデータ型。	'LineString' 'MultiPolygon' 'Number' 'Point' 'Polygon' 'String'
種類	インデックスの種類を示します。	'Hash' 'Range' 'Spatial'
精度	インデックスの有効桁数。 -1 は最大有効桁数です。	int

IndexingPolicy

名前	形容	価値
自動	インデックス作成ポリシーが自動かどうかを示します	bool
compositeIndexes	複合パス リストの一覧	CompositePath[][]
excludedPaths	インデックス作成から除外するパスの一覧	ExcludedPath[] を する
includedPaths	インデックス作成に含めるパスの一覧	IncludedPath[]
indexingMode	インデックス作成モードを示します。	'consistent' 'lazy' 'none'
spatialIndexes	空間の詳細の一覧	SpatialSpec[]
vectorIndexes	ベクター インデックス作成に含めるパスの一覧	VectorIndex[]

ManagedServiceIdentity

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

ManagedServiceIdentityUserAssignedIdentities

名前	形容	価値

MaterializedViewDefinition

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

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers

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

ResourceRestoreParameters

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

SpatialSpec

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

SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties

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

SqlContainerResourceOrSqlContainerGetPropertiesResource

名前	形容	価値
analyticalStorageTtl	分析 TTL。	int
clientEncryptionPolicy	コンテナーのクライアント暗号化ポリシー。	ClientEncryptionPolicy
computedProperties	計算プロパティの一覧	ComputedProperty[]
conflictResolutionPolicy	コンテナーの競合解決ポリシー。	ConflictResolutionPolicy
createMode	リソースの作成モードを示す列挙型。	'Default' 'Restore'
defaultTtl	既定の有効期間	int
身分証明書	Cosmos DB SQL コンテナーの名前	string (必須)
indexingPolicy	インデックス作成ポリシーの構成。 既定では、コンテナー内のすべてのドキュメント パスに対してインデックス作成が自動的に行われます。	IndexingPolicy
materializedViewDefinition	具体化されたビューを定義するための構成。 これは、具体化されたビュー コンテナーを作成する場合にのみ指定する必要があります。	MaterializedViewDefinition
partitionKey	複数のパーティションにデータをパーティション分割するために使用するパーティション キーの構成	ContainerPartitionKey
restoreParameters	復元に関する情報を示すパラメーター	ResourceRestoreParameters
uniqueKeyPolicy	Azure Cosmos DB サービス内のコレクション内のドキュメントに対する一意性制約を指定するための一意キー ポリシー構成。	UniqueKeyPolicy
vectorEmbeddingPolicy	コンテナーのベクター埋め込みポリシー。	VectorEmbeddingPolicy の

タグ

名前	形容	価値

UniqueKey

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

UniqueKeyPolicy

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

VectorEmbedding

名前	形容	価値
dataType	ベクターのデータ型を示します。	'float32' 'int8' 'uint8' (必須)
寸法	ベクトル内の次元の数。	int (必須)
distanceFunction	ベクトル間の距離計算に使用する距離関数。	'cosine' 'dotproduct' 'euclidean' (必須)
パス	ドキュメント内のベクター フィールドへのパス。	string (必須)

VectorEmbeddingPolicy

名前	形容	価値
vectorEmbeddings	ベクター埋め込みの一覧	VectorEmbedding[]

VectorIndex

名前	形容	価値
パス	ドキュメント内のベクター フィールドへのパス。	string (必須)
種類	ベクターのインデックス型。 現在、フラット、diskANN、およびクオンタイズフラットがサポートされています。	'diskANN' 'flat' 'quantizedFlat' (必須)

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

次のクイック スタート テンプレートでは、このリソースの種類をデプロイします。

テンプレート	形容
分析ストア を使用して 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-12-01-preview"
  name = "string"
  identity = {
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
      }
    }
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    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"
              ]
            }
          ]
          vectorIndexes = [
            {
              path = "string"
              type = "string"
            }
          ]
        }
        materializedViewDefinition = {
          definition = "string"
          sourceCollectionId = "string"
        }
        partitionKey = {
          kind = "string"
          paths = [
            "string"
          ]
          version = int
        }
        restoreParameters = {
          restoreSource = "string"
          restoreTimestampInUtc = "string"
          restoreWithTtlDisabled = bool
        }
        uniqueKeyPolicy = {
          uniqueKeys = [
            {
              paths = [
                "string"
              ]
            }
          ]
        }
        vectorEmbeddingPolicy = {
          vectorEmbeddings = [
            {
              dataType = "string"
              dimensions = int
              distanceFunction = "string"
              path = "string"
            }
          ]
        }
      }
    }
  })
}

プロパティ値

AutoscaleSettings

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

ClientEncryptionIncludedPath

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

ClientEncryptionPolicy

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

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

名前	形容	価値

CompositePath

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

ComputedProperty

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

ConflictResolutionPolicy

名前	形容	価値
conflictResolutionPath	LastWriterWins モードの場合の競合解決パス。	糸
conflictResolutionProcedure	カスタム モードの場合の競合を解決する手順。	糸
モード	競合解決モードを示します。	'Custom' 'LastWriterWins'

ContainerPartitionKey

名前	形容	価値
種類	パーティション分割に使用されるアルゴリズムの種類を示します。 MultiHash の場合、コンテナーの作成では複数のパーティション キー (最大 3 つ) がサポートされます	'Hash' 'MultiHash' 'Range'
パス	コンテナー内のどのデータをパーティション分割できるかを使用するパスの一覧	string[]
バージョン	パーティション キー定義のバージョンを示します	int 制約： 最小値 = 1 最大値 = 2

CreateUpdateOptionsOrSqlContainerGetPropertiesOptions

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

ExcludedPath

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

IncludedPath

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

索引

名前	形容	価値
dataType	インデックス作成の動作が適用されるデータ型。	'LineString' 'MultiPolygon' 'Number' 'Point' 'Polygon' 'String'
種類	インデックスの種類を示します。	'Hash' 'Range' 'Spatial'
精度	インデックスの有効桁数。 -1 は最大有効桁数です。	int

IndexingPolicy

名前	形容	価値
自動	インデックス作成ポリシーが自動かどうかを示します	bool
compositeIndexes	複合パス リストの一覧	CompositePath[][]
excludedPaths	インデックス作成から除外するパスの一覧	ExcludedPath[] を する
includedPaths	インデックス作成に含めるパスの一覧	IncludedPath[]
indexingMode	インデックス作成モードを示します。	'consistent' 'lazy' 'none'
spatialIndexes	空間の詳細の一覧	SpatialSpec[]
vectorIndexes	ベクター インデックス作成に含めるパスの一覧	VectorIndex[]

ManagedServiceIdentity

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

ManagedServiceIdentityUserAssignedIdentities

名前	形容	価値

MaterializedViewDefinition

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

ResourceRestoreParameters

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

SpatialSpec

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

SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties

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

SqlContainerResourceOrSqlContainerGetPropertiesResource

名前	形容	価値
analyticalStorageTtl	分析 TTL。	int
clientEncryptionPolicy	コンテナーのクライアント暗号化ポリシー。	ClientEncryptionPolicy
computedProperties	計算プロパティの一覧	ComputedProperty[]
conflictResolutionPolicy	コンテナーの競合解決ポリシー。	ConflictResolutionPolicy
createMode	リソースの作成モードを示す列挙型。	'Default' 'Restore'
defaultTtl	既定の有効期間	int
身分証明書	Cosmos DB SQL コンテナーの名前	string (必須)
indexingPolicy	インデックス作成ポリシーの構成。 既定では、コンテナー内のすべてのドキュメント パスに対してインデックス作成が自動的に行われます。	IndexingPolicy
materializedViewDefinition	具体化されたビューを定義するための構成。 これは、具体化されたビュー コンテナーを作成する場合にのみ指定する必要があります。	MaterializedViewDefinition
partitionKey	複数のパーティションにデータをパーティション分割するために使用するパーティション キーの構成	ContainerPartitionKey
restoreParameters	復元に関する情報を示すパラメーター	ResourceRestoreParameters
uniqueKeyPolicy	Azure Cosmos DB サービス内のコレクション内のドキュメントに対する一意性制約を指定するための一意キー ポリシー構成。	UniqueKeyPolicy
vectorEmbeddingPolicy	コンテナーのベクター埋め込みポリシー。	VectorEmbeddingPolicy の

タグ

名前	形容	価値

UniqueKey

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

UniqueKeyPolicy

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

VectorEmbedding

名前	形容	価値
dataType	ベクターのデータ型を示します。	'float32' 'int8' 'uint8' (必須)
寸法	ベクトル内の次元の数。	int (必須)
distanceFunction	ベクトル間の距離計算に使用する距離関数。	'cosine' 'dotproduct' 'euclidean' (必須)
パス	ドキュメント内のベクター フィールドへのパス。	string (必須)

VectorEmbeddingPolicy

名前	形容	価値
vectorEmbeddings	ベクター埋め込みの一覧	VectorEmbedding[]

VectorIndex

名前	形容	価値
パス	ドキュメント内のベクター フィールドへのパス。	string (必須)
種類	ベクターのインデックス型。 現在、フラット、diskANN、およびクオンタイズフラットがサポートされています。	'diskANN' 'flat' 'quantizedFlat' (必須)