Microsoft.DocumentDB databaseAccounts/mongodbDatabases/collections 2022-11-15-preview

• Актуальная
• 2024-05-15
• 15.05.2024 г.
• 15.02.2024 г.
• 2023-11-15
• 15.11.2023 г.
• 2023-09-15
• 15.09.2023 г.
• 2023-04-15
• 2023-03-15
• 15.03.2023 г.
• 2023-03-01-preview
• 2022-11-15
• 15.11.2022 г.
• 2022-08-15
• 2022-08-15-preview
• 2022-05-15
• 2022-05-15-preview
• 15.02.2022 г.
• 15.11.2021-preview
• 2021-10-15
• 15.10.2021 г.
• 2021-07-01-preview
• 2021-06-15
• 2021-05-15
• 2021-04-15
• 2021-04-01-preview
• 2021-03-15
• 2021-03-01-preview
• 2021-01-15
• 2020-09-01
• 2020-06-01-preview
• 2020-04-01
• 2020-03-01
• 2019-12-12
• 01.08.2019

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

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

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

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

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

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

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2022-11-15-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  properties: {
    options: {
      autoscaleSettings: {
        maxThroughput: int
      }
      throughput: int
    }
    resource: {
      analyticalStorageTtl: int
      createMode: 'string'
      id: 'string'
      indexes: [
        {
          key: {
            keys: [
              'string'
            ]
          }
          options: {
            expireAfterSeconds: int
            unique: bool
          }
        }
      ]
      restoreParameters: {
        restoreSource: 'string'
        restoreTimestampInUtc: 'string'
      }
      shardKey: {
        {customized property}: 'string'
      }
    }
  }
}

Значения свойств

databaseAccounts/mongodbDatabases/collections

Имя	Описание	Значение
name	имя ресурса. Узнайте, как задать имена и типы для дочерних ресурсов в Bicep.	строка (обязательно)
location	Расположение группы ресурсов, к которой принадлежит ресурс.	строка
tags	Теги — это список пар "ключ-значение", описывающих ресурс. Эти теги можно использовать при просмотре и группировании ресурсов (между группами). Для ресурса можно указать не более 15 тегов. В каждом теге длина ключа нее должна превышать 128 символов, а длина значения — 256 символов. Например, для типа шаблона по умолчанию задано значение defaultExperience: Cassandra. Текущие значения defaultExperience также включают "Table", "Graph", "DocumentDB" и "MongoDB".	Словарь имен и значений тегов. См . раздел Теги в шаблонах
родитель	В Bicep можно указать родительский ресурс для дочернего ресурса. Это свойство необходимо добавить только в том случае, если дочерний ресурс объявлен вне родительского ресурса. Дополнительные сведения см. в разделе Дочерний ресурс за пределами родительского ресурса.	Символьное имя ресурса типа: mongodbDatabases
удостоверение	Удостоверение ресурса.	Управляемое удостоверение службы
properties	Свойства для создания и обновления коллекции MongoDB в Azure Cosmos DB.	MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl... (обязательно)

Управляемое удостоверение службы

Имя	Описание	Значение
тип	Тип удостоверения, используемого для ресурса. Тип SystemAssigned,UserAssigned включает как неявно созданное удостоверение, так и набор удостоверений, назначаемых пользователем. Тип None удалит все удостоверения из службы.	"Нет" SystemAssigned "SystemAssigned,UserAssigned" UserAssigned
userAssignedIdentities	Список удостоверений пользователей, связанных с ресурсом. Ссылки на ключ словаря удостоверений пользователей будут иметь идентификаторы ресурсов ARM в формате "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".	ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

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

Components1Jq1T4ISchemasManagedserviceidentityProper...

Этот объект не содержит свойств, которые необходимо задать во время развертывания. Все свойства доступны только для чтения.

MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl...

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

CreateUpdateOptionsOrMongoDBCollectionGetPropertiesO...

Имя	Описание	Значение
autoscaleSettings	Задает параметры автомасштабирования.	АвтомасштабированиеПараметры
throughput	Количество запросов в секунду. Например, "пропускная способность": 10000.	INT

АвтомасштабированиеПараметры

Имя	Описание	Значение
maxThroughput	Представляет максимальную пропускную способность. Ресурс может масштабироваться до .	INT

MongoDBCollectionResourceOrMongoDBCollectionGetPrope...

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

MongoIndex

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

MongoIndexKeys

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

MongoIndexOptions

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

ResourceRestoreParameters

Имя	Описание	Значение
restoreSource	Идентификатор восстанавливаемой учетной записи базы данных, из которой должно быть инициировано восстановление. Например: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccounts}	строка
restoreTimestampInUtc	Время восстановления учетной записи (формат ISO-8601).	строка

ShardKeys

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

Шаблоны быстрого запуска

Следующие шаблоны быстрого запуска развертывают этот тип ресурса.

Шаблон	Описание
Создание учетной записи Azure Cosmos для API MongoDB	Этот шаблон создает учетную запись Azure Cosmos DB для API MongoDB 4.2 в двух регионах с использованием общей и выделенной пропускной способности с двумя коллекциями.
Создание учетной записи Azure Cosmos для автомасштабирования API MongoDB	Этот шаблон создает учетную запись Azure Cosmos DB для API MongoDB 4.2 в двух регионах с использованием общей и выделенной пропускной способности автомасштабирования.

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

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

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

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

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

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

{
  "type": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections",
  "apiVersion": "2022-11-15-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {}
    }
  },
  "properties": {
    "options": {
      "autoscaleSettings": {
        "maxThroughput": "int"
      },
      "throughput": "int"
    },
    "resource": {
      "analyticalStorageTtl": "int",
      "createMode": "string",
      "id": "string",
      "indexes": [
        {
          "key": {
            "keys": [ "string" ]
          },
          "options": {
            "expireAfterSeconds": "int",
            "unique": "bool"
          }
        }
      ],
      "restoreParameters": {
        "restoreSource": "string",
        "restoreTimestampInUtc": "string"
      },
      "shardKey": {
        "{customized property}": "string"
      }
    }
  }
}

Значения свойств

databaseAccounts/mongodbDatabases/collections

Имя	Описание	Значение
тип	Тип ресурса	Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections
версия_API	Версия API ресурсов	'2022-11-15-preview'
name	имя ресурса. Узнайте, как задать имена и типы для дочерних ресурсов в шаблонах JSON ARM.	string (обязательно)
location	Расположение группы ресурсов, к которой принадлежит ресурс.	строка
tags	Теги — это список пар "ключ-значение", описывающих ресурс. Эти теги можно использовать при просмотре и группировании ресурсов (между группами). Для ресурса можно указать не более 15 тегов. В каждом теге длина ключа нее должна превышать 128 символов, а длина значения — 256 символов. Например, по умолчанию для типа шаблона задано значение defaultExperience: Cassandra. Текущие значения defaultExperience также включают Table, Graph, DocumentDB и MongoDB.	Словарь имен и значений тегов. См . раздел Теги в шаблонах
удостоверение	Удостоверение ресурса.	Управляемое удостоверение службы
properties	Свойства для создания и обновления коллекции MongoDB в Azure Cosmos DB.	MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl... (обязательно)

Управляемое удостоверение службы

Имя	Описание	Значение
тип	Тип удостоверения, используемого для ресурса. Тип SystemAssigned,UserAssigned включает как неявно созданное удостоверение, так и набор назначенных пользователем удостоверений. Тип None удалит все удостоверения из службы.	"Нет" SystemAssigned "SystemAssigned,UserAssigned" UserAssigned
userAssignedIdentities	Список удостоверений пользователей, связанных с ресурсом. Ссылки на ключи словаря удостоверений пользователей будут иметь идентификаторы ресурсов ARM в форме: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".	ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

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

Components1Jq1T4ISchemasManagedserviceidentityProper...

Этот объект не содержит свойств, которые необходимо задать во время развертывания. Все свойства доступны только для чтения.

MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl...

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

CreateUpdateOptionsOrMongoDBCollectionGetPropertiesO...

Имя	Описание	Значение
autoscaleSettings	Задает параметры автомасштабирования.	АвтомасштабированиеПараметры
throughput	Количество запросов в секунду. Например, "пропускная способность": 10000.	INT

АвтомасштабированиеПараметры

Имя	Описание	Значение
maxThroughput	Представляет максимальную пропускную способность, до которую можно масштабировать ресурс.	INT

MongoDBCollectionResourceOrMongoDBCollectionGetPrope...

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

MongoIndex

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

MongoIndexKeys

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

MongoIndexOptions

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

ResourceRestoreParameters

Имя	Описание	Значение
restoreSource	Идентификатор восстанавливаемой учетной записи базы данных, из которой должно быть инициировано восстановление. Например: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}	строка
restoreTimestampInUtc	Время восстановления учетной записи (формат ISO-8601).	строка

ShardKeys

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

Шаблоны быстрого запуска

Следующие шаблоны быстрого запуска развертывают этот тип ресурса.

Шаблон	Описание
Создание учетной записи Azure Cosmos для API MongoDB	Этот шаблон создает учетную запись Azure Cosmos DB для API MongoDB 4.2 в двух регионах с использованием общей и выделенной пропускной способности с двумя коллекциями.
Создание учетной записи Azure Cosmos для автомасштабирования API MongoDB	Этот шаблон создает учетную запись Azure Cosmos DB для API MongoDB 4.2 в двух регионах с использованием общей и выделенной автомасштабируемой пропускной способности.

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

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

• Группы ресурсов

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

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

Чтобы создать ресурс Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections, добавьте в шаблон следующую terraform.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2022-11-15-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "string"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      options = {
        autoscaleSettings = {
          maxThroughput = int
        }
        throughput = int
      }
      resource = {
        analyticalStorageTtl = int
        createMode = "string"
        id = "string"
        indexes = [
          {
            key = {
              keys = [
                "string"
              ]
            }
            options = {
              expireAfterSeconds = int
              unique = bool
            }
          }
        ]
        restoreParameters = {
          restoreSource = "string"
          restoreTimestampInUtc = "string"
        }
        shardKey = {
          {customized property} = "string"
        }
      }
    }
  })
}

Значения свойств

databaseAccounts/mongodbDatabases/collections

Имя	Описание	Значение
тип	Тип ресурса	"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2022-11-15-preview"
name	имя ресурса.	строка (обязательно)
location	Расположение группы ресурсов, к которой принадлежит ресурс.	строка
parent_id	Идентификатор ресурса, который является родительским для этого ресурса.	Идентификатор ресурса типа mongodbDatabases
tags	Теги — это список пар "ключ-значение", описывающих ресурс. Эти теги можно использовать при просмотре и группировании ресурсов (между группами). Для ресурса можно указать не более 15 тегов. В каждом теге длина ключа нее должна превышать 128 символов, а длина значения — 256 символов. Например, для типа шаблона по умолчанию задано значение defaultExperience: Cassandra. Текущие значения defaultExperience также включают "Table", "Graph", "DocumentDB" и "MongoDB".	Словарь имен и значений тегов.
удостоверение	Удостоверение ресурса.	Управляемое удостоверение службы
properties	Свойства для создания и обновления коллекции MongoDB в Azure Cosmos DB.	MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl... (обязательно)

Управляемое удостоверение службы

Имя	Описание	Значение
тип	Тип удостоверения, используемого для ресурса. Тип SystemAssigned,UserAssigned включает как неявно созданное удостоверение, так и набор удостоверений, назначаемых пользователем. Тип None удалит все удостоверения из службы.	"SystemAssigned" "SystemAssigned,UserAssigned" UserAssigned
identity_ids	Список удостоверений пользователей, связанных с ресурсом. Ссылки на ключ словаря удостоверений пользователей будут иметь идентификаторы ресурсов ARM в формате "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".	Массив идентификаторов удостоверений пользователей.

ManagedServiceIdentityUserAssignedIdentities

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

Components1Jq1T4ISchemasManagedserviceidentityProper...

Этот объект не содержит свойств, которые необходимо задать во время развертывания. Все свойства доступны только для чтения.

MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl...

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

CreateUpdateOptionsOrMongoDBCollectionGetPropertiesO...

Имя	Описание	Значение
autoscaleSettings	Задает параметры автомасштабирования.	АвтомасштабированиеПараметры
throughput	Количество запросов в секунду. Например, "пропускная способность": 10000.	INT

АвтомасштабированиеПараметры

Имя	Описание	Значение
maxThroughput	Представляет максимальную пропускную способность, до которую можно масштабировать ресурс.	INT

MongoDBCollectionResourceOrMongoDBCollectionGetPrope...

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

MongoIndex

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

MongoIndexKeys

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

MongoIndexOptions

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

ResourceRestoreParameters

Имя	Описание	Значение
restoreSource	Идентификатор восстанавливаемой учетной записи базы данных, из которой должно быть инициировано восстановление. Например: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccounts}	строка
restoreTimestampInUtc	Время восстановления учетной записи (формат ISO-8601).	строка

ShardKeys

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