Microsoft.DocumentDB databaseAccounts/apis/databases/containers 2016-03-31

• 最新の を する
• 2016-03-31
• 2016-03-19
• 2015-11-06
• 2015-04-08
• 2015-04-01

Bicep リソース定義

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

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

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

リソースの形式

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

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/apis/databases/containers@2016-03-31' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    options: {
      {customized property}: 'string'
    }
    resource: {
      conflictResolutionPolicy: {
        conflictResolutionPath: 'string'
        conflictResolutionProcedure: 'string'
        mode: 'string'
      }
      defaultTtl: int
      id: 'string'
      indexingPolicy: {
        automatic: bool
        excludedPaths: [
          {
            path: 'string'
          }
        ]
        includedPaths: [
          {
            indexes: [
              {
                dataType: 'string'
                kind: 'string'
                precision: int
              }
            ]
            path: 'string'
          }
        ]
        indexingMode: 'string'
      }
      partitionKey: {
        kind: 'string'
        paths: [
          'string'
        ]
      }
      uniqueKeyPolicy: {
        uniqueKeys: [
          {
            paths: [
              'string'
            ]
          }
        ]
      }
    }
  }
}

プロパティ値

ConflictResolutionPolicy

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

ContainerPartitionKey

名前	形容	価値
種類	パーティション分割に使用されるアルゴリズムの種類を示します	'Hash' 'Range'
パス	コンテナー内のどのデータをパーティション分割できるかを使用するパスの一覧	string[]

CreateUpdateOptions

名前	形容	価値

ExcludedPath

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

IncludedPath

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

索引

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

IndexingPolicy

名前	形容	価値
自動	インデックス作成ポリシーが自動かどうかを示します	bool
excludedPaths	インデックス作成から除外するパスの一覧	ExcludedPath[] を する
includedPaths	インデックス作成に含めるパスの一覧	IncludedPath[]
indexingMode	インデックス作成モードを示します。	'Consistent' 'Lazy' 'None'

Microsoft.DocumentDB/databaseAccounts/apis/databases/containers

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

SqlContainerCreateUpdatePropertiesOrSqlContainerProperties

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

SqlContainerResource

名前	形容	価値
conflictResolutionPolicy	コンテナーの競合解決ポリシー。	ConflictResolutionPolicy
defaultTtl	既定の有効期間	int
身分証明書	Cosmos DB SQL コンテナーの名前	string (必須)
indexingPolicy	インデックス作成ポリシーの構成。 既定では、コンテナー内のすべてのドキュメント パスに対してインデックス作成が自動的に行われます。	IndexingPolicy
partitionKey	複数のパーティションにデータをパーティション分割するために使用するパーティション キーの構成	ContainerPartitionKey
uniqueKeyPolicy	Azure Cosmos DB サービス内のコレクション内のドキュメントに対する一意性制約を指定するための一意キー ポリシー構成。	UniqueKeyPolicy

UniqueKey

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

UniqueKeyPolicy

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

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

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

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

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

リソースの形式

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

{
  "type": "Microsoft.DocumentDB/databaseAccounts/apis/databases/containers",
  "apiVersion": "2016-03-31",
  "name": "string",
  "properties": {
    "options": {
      "{customized property}": "string"
    },
    "resource": {
      "conflictResolutionPolicy": {
        "conflictResolutionPath": "string",
        "conflictResolutionProcedure": "string",
        "mode": "string"
      },
      "defaultTtl": "int",
      "id": "string",
      "indexingPolicy": {
        "automatic": "bool",
        "excludedPaths": [
          {
            "path": "string"
          }
        ],
        "includedPaths": [
          {
            "indexes": [
              {
                "dataType": "string",
                "kind": "string",
                "precision": "int"
              }
            ],
            "path": "string"
          }
        ],
        "indexingMode": "string"
      },
      "partitionKey": {
        "kind": "string",
        "paths": [ "string" ]
      },
      "uniqueKeyPolicy": {
        "uniqueKeys": [
          {
            "paths": [ "string" ]
          }
        ]
      }
    }
  }
}

プロパティ値

ConflictResolutionPolicy

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

ContainerPartitionKey

名前	形容	価値
種類	パーティション分割に使用されるアルゴリズムの種類を示します	'Hash' 'Range'
パス	コンテナー内のどのデータをパーティション分割できるかを使用するパスの一覧	string[]

CreateUpdateOptions

名前	形容	価値

ExcludedPath

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

IncludedPath

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

索引

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

IndexingPolicy

名前	形容	価値
自動	インデックス作成ポリシーが自動かどうかを示します	bool
excludedPaths	インデックス作成から除外するパスの一覧	ExcludedPath[] を する
includedPaths	インデックス作成に含めるパスの一覧	IncludedPath[]
indexingMode	インデックス作成モードを示します。	'Consistent' 'Lazy' 'None'

Microsoft.DocumentDB/databaseAccounts/apis/databases/containers

名前	形容	価値
apiVersion	API のバージョン	'2016-03-31'
名前	リソース名	string (必須)
プロパティ	Azure Cosmos DB コンテナーを作成および更新するためのプロパティ。	SqlContainerCreateUpdatePropertiesOrSqlContainerProperties (必須)
種類	リソースの種類	'Microsoft.DocumentDB/databaseAccounts/apis/databases/containers'

SqlContainerCreateUpdatePropertiesOrSqlContainerProperties

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

SqlContainerResource

名前	形容	価値
conflictResolutionPolicy	コンテナーの競合解決ポリシー。	ConflictResolutionPolicy
defaultTtl	既定の有効期間	int
身分証明書	Cosmos DB SQL コンテナーの名前	string (必須)
indexingPolicy	インデックス作成ポリシーの構成。 既定では、コンテナー内のすべてのドキュメント パスに対してインデックス作成が自動的に行われます。	IndexingPolicy
partitionKey	複数のパーティションにデータをパーティション分割するために使用するパーティション キーの構成	ContainerPartitionKey
uniqueKeyPolicy	Azure Cosmos DB サービス内のコレクション内のドキュメントに対する一意性制約を指定するための一意キー ポリシー構成。	UniqueKeyPolicy

UniqueKey

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

UniqueKeyPolicy

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

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

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

テンプレート	形容
SQL API と複数のコンテナーを使用して Azure Cosmos を作成 Azure にデプロイする	このテンプレートでは、SQL API を使用して Cosmos コンテナーを作成し、複数のコンテナーを追加できます。

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

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

• リソース グループの

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

リソースの形式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/apis/databases/containers@2016-03-31"
  name = "string"
  body = jsonencode({
    properties = {
      options = {
        {customized property} = "string"
      }
      resource = {
        conflictResolutionPolicy = {
          conflictResolutionPath = "string"
          conflictResolutionProcedure = "string"
          mode = "string"
        }
        defaultTtl = int
        id = "string"
        indexingPolicy = {
          automatic = bool
          excludedPaths = [
            {
              path = "string"
            }
          ]
          includedPaths = [
            {
              indexes = [
                {
                  dataType = "string"
                  kind = "string"
                  precision = int
                }
              ]
              path = "string"
            }
          ]
          indexingMode = "string"
        }
        partitionKey = {
          kind = "string"
          paths = [
            "string"
          ]
        }
        uniqueKeyPolicy = {
          uniqueKeys = [
            {
              paths = [
                "string"
              ]
            }
          ]
        }
      }
    }
  })
}

プロパティ値

ConflictResolutionPolicy

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

ContainerPartitionKey

名前	形容	価値
種類	パーティション分割に使用されるアルゴリズムの種類を示します	'Hash' 'Range'
パス	コンテナー内のどのデータをパーティション分割できるかを使用するパスの一覧	string[]

CreateUpdateOptions

名前	形容	価値

ExcludedPath

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

IncludedPath

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

索引

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

IndexingPolicy

名前	形容	価値
自動	インデックス作成ポリシーが自動かどうかを示します	bool
excludedPaths	インデックス作成から除外するパスの一覧	ExcludedPath[] を する
includedPaths	インデックス作成に含めるパスの一覧	IncludedPath[]
indexingMode	インデックス作成モードを示します。	'Consistent' 'Lazy' 'None'

Microsoft.DocumentDB/databaseAccounts/apis/databases/containers

名前	形容	価値
名前	リソース名	string (必須)
parent_id	このリソースの親であるリソースの ID。	種類のリソースの ID: databaseAccounts/apis/databases
プロパティ	Azure Cosmos DB コンテナーを作成および更新するためのプロパティ。	SqlContainerCreateUpdatePropertiesOrSqlContainerProperties (必須)
種類	リソースの種類	"Microsoft.DocumentDB/databaseAccounts/apis/databases/containers@2016-03-31"

SqlContainerCreateUpdatePropertiesOrSqlContainerProperties

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

SqlContainerResource

名前	形容	価値
conflictResolutionPolicy	コンテナーの競合解決ポリシー。	ConflictResolutionPolicy
defaultTtl	既定の有効期間	int
身分証明書	Cosmos DB SQL コンテナーの名前	string (必須)
indexingPolicy	インデックス作成ポリシーの構成。 既定では、コンテナー内のすべてのドキュメント パスに対してインデックス作成が自動的に行われます。	IndexingPolicy
partitionKey	複数のパーティションにデータをパーティション分割するために使用するパーティション キーの構成	ContainerPartitionKey
uniqueKeyPolicy	Azure Cosmos DB サービス内のコレクション内のドキュメントに対する一意性制約を指定するための一意キー ポリシー構成。	UniqueKeyPolicy

UniqueKey

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

UniqueKeyPolicy

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