次の方法で共有

Microsoft.DocumentDB databaseAccounts/apis/databases/collections 2016-03-19

  • [アーティクル]

Bicep リソース定義

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

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

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

リソースの形式

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

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

プロパティ値

CreateUpdateOptions

名前 形容 価値

Microsoft.DocumentDB/databaseAccounts/apis/databases/collections

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

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

MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionProperties

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

MongoDBCollectionResource

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

MongoIndex

名前 形容 価値
鍵 Cosmos DB MongoDB コレクションのインデックス キー MongoIndexKeys
オプション Cosmos DB MongoDB コレクションのインデックス キー オプション MongoIndexOptions

MongoIndexKeys

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

MongoIndexOptions

名前 形容 価値
expireAfterSeconds 秒後に有効期限が切れる int
ユニーク 一意かどうか bool

ShardKeys

名前 形容 価値

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

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

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

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

リソースの形式

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

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

プロパティ値

CreateUpdateOptions

名前 形容 価値

Microsoft.DocumentDB/databaseAccounts/apis/databases/collections

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

MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionProperties

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

MongoDBCollectionResource

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

MongoIndex

名前 形容 価値
鍵 Cosmos DB MongoDB コレクションのインデックス キー MongoIndexKeys
オプション Cosmos DB MongoDB コレクションのインデックス キー オプション MongoIndexOptions

MongoIndexKeys

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

MongoIndexOptions

名前 形容 価値
expireAfterSeconds 秒後に有効期限が切れる int
ユニーク 一意かどうか bool

ShardKeys

名前 形容 価値

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@2016-03-19"
  name = "string"
  body = jsonencode({
    properties = {
      options = {
        {customized property} = "string"
      }
      resource = {
        id = "string"
        indexes = [
          {
            key = {
              keys = [
                "string"
              ]
            }
            options = {
              expireAfterSeconds = int
              unique = bool
            }
          }
        ]
        shardKey = {
          {customized property} = "string"
        }
      }
    }
  })
}

プロパティ値

CreateUpdateOptions

名前 形容 価値

Microsoft.DocumentDB/databaseAccounts/apis/databases/collections

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

MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionProperties

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

MongoDBCollectionResource

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

MongoIndex

名前 形容 価値
鍵 Cosmos DB MongoDB コレクションのインデックス キー MongoIndexKeys
オプション Cosmos DB MongoDB コレクションのインデックス キー オプション MongoIndexOptions

MongoIndexKeys

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

MongoIndexOptions

名前 形容 価値
expireAfterSeconds 秒後に有効期限が切れる int
ユニーク 一意かどうか bool

ShardKeys

名前 形容 価値