База данных Microsoft.DocumentDBAccounts/apis/databases/collections 2015-11-06

• Актуальная
• 2016-03-31
• 2016-03-19
• 2015-11-06
• 2015-04-08
• 2015-04-01

Определение ресурса Bicep

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

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

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

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

Чтобы создать ресурс Microsoft.DocumentDB/databaseAccounts/apis/databases/collections, добавьте в шаблон следующий Bicep.

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/apis/databases/collections@2015-11-06' = {
  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 (обязательно)
родитель	В Bicep можно указать родительский ресурс для дочернего ресурса. Это свойство необходимо добавить только в том случае, если дочерний ресурс объявлен за пределами родительского ресурса. Дополнительные сведения см. в разделе Дочерний ресурс за пределами родительского ресурса.	Символьное имя ресурса типа базы данных
properties	Свойства для создания и обновления коллекции MongoDB в Azure Cosmos DB.	MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl... (обязательно)

MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl...

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

CreateUpdateOptions

Имя	Описание	Значение
{настраиваемое свойство}		строка

MongoDBCollectionResource

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

MongoIndex

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

MongoIndexKeys

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

MongoIndexOptions

Имя	Описание	Значение
expireAfterSeconds	Срок действия истекает через секунды	INT
unique	Является уникальным или нет	bool

ShardKeys

Имя	Описание	Значение
{настраиваемое свойство}		строка

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

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

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

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

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

Чтобы создать ресурс Microsoft.DocumentDB/databaseAccounts/apis/databases/collections, добавьте следующий код JSON в шаблон.

{
  "type": "Microsoft.DocumentDB/databaseAccounts/apis/databases/collections",
  "apiVersion": "2015-11-06",
  "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

Имя	Описание	Значение
тип	Тип ресурса	Microsoft.DocumentDB/databaseAccounts/apis/databases/collections
версия_API	Версия API ресурсов	'2015-11-06'
name	имя ресурса. Узнайте, как задать имена и типы для дочерних ресурсов в шаблонах JSON ARM.	string (обязательно)
properties	Свойства для создания и обновления коллекции MongoDB в Azure Cosmos DB.	MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl... (обязательно)

MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl...

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

CreateUpdateOptions

Имя	Описание	Значение
{настраиваемое свойство}		строка

MongoDBCollectionResource

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

MongoIndex

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

MongoIndexKeys

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

MongoIndexOptions

Имя	Описание	Значение
expireAfterSeconds	Срок действия истекает через секунды	INT
unique	Является уникальным или нет	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@2015-11-06"
  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

Имя	Описание	Значение
тип	Тип ресурса	"Microsoft.DocumentDB/databaseAccounts/apis/databases/collections@2015-11-06"
name	имя ресурса.	string (обязательно)
parent_id	Идентификатор ресурса, который является родительским для этого ресурса.	Идентификатор ресурса типа: databases
properties	Свойства для создания и обновления коллекции MongoDB в Azure Cosmos DB.	MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl... (обязательно)

MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl...

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

CreateUpdateOptions

Имя	Описание	Значение
{настраиваемое свойство}		строка

MongoDBCollectionResource

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

MongoIndex

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

MongoIndexKeys

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

MongoIndexOptions

Имя	Описание	Значение
expireAfterSeconds	Срок действия истекает через секунды	INT
unique	Является уникальным или нет	bool

ShardKeys

Имя	Описание	Значение
{настраиваемое свойство}		строка