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

  • [アーティクル]

Bicep リソース定義

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

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

リソース形式

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

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/apis/databases/collections@2015-04-08' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    options: {
      {customized property}: 'string'
    }
    resource: {
      id: 'string'
      indexes: [
        {
          key: {
            keys: [
              'string'
            ]
          }
          options: {
            expireAfterSeconds: int
            unique: bool
          }
        }
      ]
      shardKey: {
        {customized property}: 'string'
      }
    }
  }
}

プロパティ値

databaseAccounts/apis/databases/collections

名前 説明 値
name リソース名

Bicep で子リソースの名前と型を設定する方法を参照してください。		 string (必須)
parent Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。

詳細については、「 親リソースの外部の子リソース」を参照してください。		 種類のリソースのシンボル名: データベース
properties Azure Cosmos DB MongoDB コレクションを作成および更新するためのプロパティ。 MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl... (必須)

MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl...

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

CreateUpdateOptions

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

MongoDBCollectionResource

名前 説明 値
id Cosmos DB MongoDB コレクションの名前 string (必須)
インデックス インデックス キーの一覧 MongoIndex[]
shardKey 要求に適用されるシャード キーのキーと値のペア。 ShardKeys

MongoIndex

名前 説明 値
キー Cosmos DB MongoDB コレクションのインデックス キー MongoIndexKeys
options Cosmos DB MongoDB コレクションのインデックス キー オプション MongoIndexOptions

MongoIndexKeys

名前 説明 値
キー Azure Cosmos DB サービス内の各 MongoDB コレクションのキーの一覧 string[]

MongoIndexOptions

名前 説明 値
expireAfterSeconds 秒後に有効期限が切れる INT
unique 一意かどうか [bool]

ShardKeys

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

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

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

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

リソース形式

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

{
  "type": "Microsoft.DocumentDB/databaseAccounts/apis/databases/collections",
  "apiVersion": "2015-04-08",
  "name": "string",
  "properties": {
    "options": {
      "{customized property}": "string"
    },
    "resource": {
      "id": "string",
      "indexes": [
        {
          "key": {
            "keys": [ "string" ]
          },
          "options": {
            "expireAfterSeconds": "int",
            "unique": "bool"
          }
        }
      ],
      "shardKey": {
        "{customized property}": "string"
      }
    }
  }
}

プロパティ値

databaseAccounts/apis/databases/collections

名前 説明 値
type リソースの種類 'Microsoft.DocumentDB/databaseAccounts/apis/databases/collections'
apiVersion リソース API のバージョン '2015-04-08'
name リソース名

JSON ARM テンプレートで子リソースの名前と型を設定する方法を参照してください。		 string (必須)
properties Azure Cosmos DB MongoDB コレクションを作成および更新するためのプロパティ。 MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl... (必須)

MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl...

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

CreateUpdateOptions

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

MongoDBCollectionResource

名前 説明 値
id Cosmos DB MongoDB コレクションの名前 string (必須)
インデックス インデックス キーの一覧 MongoIndex[]
shardKey 要求に適用するシャード キーのキーと値のペア。 ShardKeys

MongoIndex

名前 説明 値
キー Cosmos DB MongoDB コレクションのインデックス キー MongoIndexKeys
options Cosmos DB MongoDB コレクションのインデックス キー オプション MongoIndexOptions

MongoIndexKeys

名前 説明 値
キー Azure Cosmos DB サービス内の各 MongoDB コレクションのキーの一覧 string[]

MongoIndexOptions

名前 説明 値
expireAfterSeconds 秒後に有効期限が切れる INT
unique 一意かどうか [bool]

ShardKeys

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

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

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

  • リソース グループ

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

リソース形式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/apis/databases/collections@2015-04-08"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      options = {
        {customized property} = "string"
      }
      resource = {
        id = "string"
        indexes = [
          {
            key = {
              keys = [
                "string"
              ]
            }
            options = {
              expireAfterSeconds = int
              unique = bool
            }
          }
        ]
        shardKey = {
          {customized property} = "string"
        }
      }
    }
  })
}

プロパティ値

databaseAccounts/apis/databases/collections

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

MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl...

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

CreateUpdateOptions

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

MongoDBCollectionResource

名前 説明 値
id Cosmos DB MongoDB コレクションの名前 string (必須)
インデックス インデックス キーの一覧 MongoIndex[]
shardKey 要求に適用するシャード キーのキーと値のペア。 ShardKeys

MongoIndex

名前 説明 値
キー Cosmos DB MongoDB コレクションのインデックス キー MongoIndexKeys
options Cosmos DB MongoDB コレクションのインデックス キー オプション MongoIndexOptions

MongoIndexKeys

名前 説明 値
キー Azure Cosmos DB サービス内の各 MongoDB コレクションのキーの一覧 string[]

MongoIndexOptions

名前 説明 値
expireAfterSeconds 秒後に有効期限が切れる INT
unique 一意かどうか [bool]

ShardKeys

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