Microsoft.DocumentDB databaseAccounts/apis/databases/containers 2015-04-08

• 最新
• 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@2015-04-08' = {
  name: 'string'
  parent: resourceSymbolicName
  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'
            ]
          }
        ]
      }
    }
  }
}

プロパティ値

databaseAccounts/apis/databases/containers

名前	説明	値
name	リソース名 Bicep で子リソースの名前と型を設定する方法を参照してください。	string (必須)
parent	Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。 詳細については、「 親リソースの外部にある子リソース」を参照してください。	型のリソースのシンボル名: データベース
properties	Azure Cosmos DB コンテナーを作成および更新するためのプロパティ。	SqlContainerCreateUpdatePropertiesOrSqlContainerProp... (必須)

SqlContainerCreateUpdatePropertiesOrSqlContainerProp...

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

CreateUpdateOptions

名前	説明	値
{カスタマイズされたプロパティ}		string

SqlContainerResource

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

ConflictResolutionPolicy

名前	説明	値
conflictResolutionPath	LastWriterWins モードの場合の競合解決パス。	string
conflictResolutionProcedure	カスタム モードの場合の競合を解決する手順。	string
mode	競合解決モードを示します。	'Custom' 'LastWriterWins'

IndexingPolicy

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

ExcludedPath

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

IncludedPath

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

インデックス

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

ContainerPartitionKey

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

UniqueKeyPolicy

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

UniqueKey

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

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

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

Template	説明
SQL API と複数のコンテナーを使用して Azure Cosmos を作成する	このテンプレートでは、SQL API を使用して Cosmos コンテナーを作成し、複数のコンテナーを追加できます。

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

databaseAccounts/apis/databases/containers リソースの種類は、次を対象とする操作でデプロイできます。

• リソース グループ - リソース グループのデプロイ コマンドに関するページを参照してください

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

リソース形式

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

{
  "type": "Microsoft.DocumentDB/databaseAccounts/apis/databases/containers",
  "apiVersion": "2015-04-08",
  "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" ]
          }
        ]
      }
    }
  }
}

プロパティ値

databaseAccounts/apis/databases/containers

名前	説明	値
type	リソースの種類	'Microsoft.DocumentDB/databaseAccounts/apis/databases/containers'
apiVersion	リソース API のバージョン	'2015-04-08'
name	リソース名 JSON ARM テンプレートで子リソースの名前と型を設定する方法を参照してください。	string (必須)
properties	Azure Cosmos DB コンテナーを作成および更新するためのプロパティ。	SqlContainerCreateUpdatePropertiesOrSqlContainerProp... (必須)

SqlContainerCreateUpdatePropertiesOrSqlContainerProp...

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

CreateUpdateOptions

名前	説明	値
{カスタマイズされたプロパティ}		string

SqlContainerResource

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

ConflictResolutionPolicy

名前	説明	値
conflictResolutionPath	LastWriterWins モードの場合の競合解決パス。	string
conflictResolutionProcedure	カスタム モードの場合の競合を解決する手順。	string
mode	競合解決モードを示します。	'Custom' 'LastWriterWins'

IndexingPolicy

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

ExcludedPath

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

IncludedPath

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

インデックス

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

ContainerPartitionKey

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

UniqueKeyPolicy

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

UniqueKey

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

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

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

Template	説明
SQL API と複数のコンテナーを使用して Azure Cosmos を作成する	このテンプレートでは、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@2015-04-08"
  name = "string"
  parent_id = "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"
              ]
            }
          ]
        }
      }
    }
  })
}

プロパティ値

databaseAccounts/apis/databases/containers

名前	説明	値
type	リソースの種類	"Microsoft.DocumentDB/databaseAccounts/apis/databases/containers@2015-04-08"
name	リソース名	string (必須)
parent_id	このリソースの親であるリソースの ID。	種類のリソースの ID: データベース
properties	Azure Cosmos DB コンテナーを作成および更新するためのプロパティ。	SqlContainerCreateUpdatePropertiesOrSqlContainerProp... (必須)

SqlContainerCreateUpdatePropertiesOrSqlContainerProp...

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

CreateUpdateOptions

名前	説明	値
{カスタマイズされたプロパティ}		string

SqlContainerResource

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

ConflictResolutionPolicy

名前	説明	値
conflictResolutionPath	LastWriterWins モードの場合の競合解決パス。	string
conflictResolutionProcedure	カスタム モードの場合の競合を解決する手順。	string
mode	競合解決モードを示します。	"Custom" "LastWriterWins"

IndexingPolicy

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

ExcludedPath

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

IncludedPath

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

インデックス

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

ContainerPartitionKey

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

UniqueKeyPolicy

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

UniqueKey

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