База данных Microsoft.DocumentDBAccounts/apis/database/collections 2016-03-19

• последние
• 2016-03-31
• 2016-03-19
• 2015-11-06
• 2015-04-08
• 2015-04-01

Определение ресурсов Bicep

Тип ресурса databaseAccounts/apis/database/collections можно развернуть с помощью операций, предназначенных для следующих операций:

• группы ресурсов . См. команды развертывания группы ресурсов

Список измененных свойств в каждой версии API см. в журнала изменений.

Формат ресурса

Чтобы создать ресурс Microsoft.DocumentDB/databaseAccounts/apis/database/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/database/collections

Имя	Описание	Ценность
имя	Имя ресурса	строка (обязательно)
родитель	В Bicep можно указать родительский ресурс для дочернего ресурса. Это свойство необходимо добавить, только если дочерний ресурс объявлен за пределами родительского ресурса. Дополнительные сведения см. в разделе Дочерний ресурс за пределами родительского ресурса.	Символьное имя ресурса типа: databaseAccounts/apis/database
свойства	Свойства для создания и обновления коллекции MongoDB Azure Cosmos DB.	MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionProperties (обязательно)

MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionProperties

Имя	Описание	Ценность
Параметры	Пара параметров с ключом-значением, применяемая для запроса. Это соответствует заголовкам, отправленным запросом.	CreateUpdateOptions (обязательно)
ресурс	Стандартный формат JSON коллекции MongoDB	MongoDBCollectionResource (обязательно)

MongoDBCollectionResource

Имя	Описание	Ценность
идентификатор	Имя коллекции MongoDB Cosmos DB	строка (обязательно)
Индексы	Список ключей индекса	MongoIndex[]
shardKey	Пара "ключ-значение" ключей сегментов, применяемая для запроса.	ShardKeys

MongoIndex

Имя	Описание	Ценность
ключ	Ключи индекса коллекции MongoDB Cosmos DB	MongoIndexKeys
Параметры	Параметры ключа индекса индекса коллекции Cosmos DB MongoDB	MongoIndexOptions

MongoIndexKeys

Имя	Описание	Ценность
Ключи	Список ключей для каждой коллекции MongoDB в службе Azure Cosmos DB	string[]

MongoIndexOptions

Имя	Описание	Ценность
expireAfterSeconds	Срок действия через секунды	int
уникальный	Уникально или нет	bool

ShardKeys

Имя	Описание	Ценность

Определение ресурса шаблона ARM

Тип ресурса databaseAccounts/apis/database/collections можно развернуть с помощью операций, предназначенных для следующих операций:

• группы ресурсов . См. команды развертывания группы ресурсов

Список измененных свойств в каждой версии API см. в журнала изменений.

Формат ресурса

Чтобы создать ресурс Microsoft.DocumentDB/databaseAccounts/apis/database/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/database/collections

Имя	Описание	Ценность
apiVersion	Версия API	'2016-03-19'
имя	Имя ресурса	строка (обязательно)
свойства	Свойства для создания и обновления коллекции MongoDB Azure Cosmos DB.	MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionProperties (обязательно)
тип	Тип ресурса	"Microsoft.DocumentDB/databaseAccounts/apis/database/collections"

MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionProperties

Имя	Описание	Ценность
Параметры	Пара параметров с ключом-значением, применяемая для запроса. Это соответствует заголовкам, отправленным запросом.	CreateUpdateOptions (обязательно)
ресурс	Стандартный формат JSON коллекции MongoDB	MongoDBCollectionResource (обязательно)

MongoDBCollectionResource

Имя	Описание	Ценность
идентификатор	Имя коллекции MongoDB Cosmos DB	строка (обязательно)
Индексы	Список ключей индекса	MongoIndex[]
shardKey	Пара "ключ-значение" ключей сегментов, применяемая для запроса.	ShardKeys

MongoIndex

Имя	Описание	Ценность
ключ	Ключи индекса коллекции MongoDB Cosmos DB	MongoIndexKeys
Параметры	Параметры ключа индекса индекса коллекции Cosmos DB MongoDB	MongoIndexOptions

MongoIndexKeys

Имя	Описание	Ценность
Ключи	Список ключей для каждой коллекции MongoDB в службе Azure Cosmos DB	string[]

MongoIndexOptions

Имя	Описание	Ценность
expireAfterSeconds	Срок действия через секунды	int
уникальный	Уникально или нет	bool

ShardKeys

Имя	Описание	Ценность

Определение ресурса Terraform (поставщик AzAPI)

Тип ресурса databaseAccounts/apis/database/collections можно развернуть с помощью операций, предназначенных для следующих операций:

• групп ресурсов

Список измененных свойств в каждой версии API см. в журнала изменений.

Формат ресурса

Чтобы создать ресурс Microsoft.DocumentDB/databaseAccounts/apis/database/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/database/collections

Имя	Описание	Ценность
имя	Имя ресурса	строка (обязательно)
parent_id	Идентификатор ресурса, который является родительским для этого ресурса.	Идентификатор ресурса типа: databaseAccounts/apis/database
свойства	Свойства для создания и обновления коллекции MongoDB Azure Cosmos DB.	MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionProperties (обязательно)
тип	Тип ресурса	"Microsoft.DocumentDB/databaseAccounts/apis/database/collections@2016-03-19"

MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionProperties

Имя	Описание	Ценность
Параметры	Пара параметров с ключом-значением, применяемая для запроса. Это соответствует заголовкам, отправленным запросом.	CreateUpdateOptions (обязательно)
ресурс	Стандартный формат JSON коллекции MongoDB	MongoDBCollectionResource (обязательно)

MongoDBCollectionResource

Имя	Описание	Ценность
идентификатор	Имя коллекции MongoDB Cosmos DB	строка (обязательно)
Индексы	Список ключей индекса	MongoIndex[]
shardKey	Пара "ключ-значение" ключей сегментов, применяемая для запроса.	ShardKeys

MongoIndex

Имя	Описание	Ценность
ключ	Ключи индекса коллекции MongoDB Cosmos DB	MongoIndexKeys
Параметры	Параметры ключа индекса индекса коллекции Cosmos DB MongoDB	MongoIndexOptions

MongoIndexKeys

Имя	Описание	Ценность
Ключи	Список ключей для каждой коллекции MongoDB в службе Azure Cosmos DB	string[]

MongoIndexOptions

Имя	Описание	Ценность
expireAfterSeconds	Срок действия через секунды	int
уникальный	Уникально или нет	bool

ShardKeys

Имя	Описание	Ценность