База данных Microsoft.DocumentDBAccounts/mongodbDatabases/collections 2024-12-01-preview

• последние
• 2024-12-01-preview
• 2024-11-15
• 2024-09-01-preview
• 2024-08-15
• 2024-05-15
• 2024-05-15-preview
• 2024-02-15-preview
• 2023-11-15
• 2023-11-15-preview
• 2023-09-15
• 2023-09-15-preview
• 2023-04-15
• 2023-03-15
• 2023-03-15-preview
• 2023-03-01-preview
• 2022-11-15
• 2022-11-15-preview
• 2022-08-15
• 2022-08-15-preview
• 2022-05-15
• 2022-05-15-preview
• 2022-02-15-preview
• 2021-11-15-preview
• 2021-10-15
• 2021-10-15-preview
• 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
• 2019-08-01

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

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

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

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

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

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

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2024-12-01-preview' = {
  parent: resourceSymbolicName
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'string'
  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'
        restoreWithTtlDisabled: bool
      }
      shardKey: {
        {customized property}: 'string'
      }
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

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

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

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

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

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

CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions

Имя	Описание	Ценность
autoscaleSettings	Задает параметры автомасштабирования. Примечание. Требуется либо пропускная способность, либо автомасштабированиеSettings, но не оба.	AutoscaleSettings
производительность	Единицы запроса в секунду. Например, "пропускная способность": 10000.	int

ManagedServiceIdentity

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

ManagedServiceIdentityUserAssignedIdentities

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

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections

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

MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties

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

MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource

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

MongoIndex

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

MongoIndexKeys

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

MongoIndexOptions

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

ResourceRestoreParameters

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

ShardKeys

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

Теги

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

Примеры краткого руководства

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

Bicep-файл	Описание
создание учетной записи 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": "2024-12-01-preview",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "location": "string",
  "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",
        "restoreWithTtlDisabled": "bool"
      },
      "shardKey": {
        "{customized property}": "string"
      }
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

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

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

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

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

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

CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions

Имя	Описание	Ценность
autoscaleSettings	Задает параметры автомасштабирования. Примечание. Требуется либо пропускная способность, либо автомасштабированиеSettings, но не оба.	AutoscaleSettings
производительность	Единицы запроса в секунду. Например, "пропускная способность": 10000.	int

ManagedServiceIdentity

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

ManagedServiceIdentityUserAssignedIdentities

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

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections

Имя	Описание	Ценность
apiVersion	Версия API	'2024-12-01-preview'
тождество	Удостоверение ресурса.	ManagedServiceIdentity
местоположение	Расположение группы ресурсов, к которой принадлежит ресурс.	струна
имя	Имя ресурса	строка (обязательно)
свойства	Свойства для создания и обновления коллекции MongoDB Azure Cosmos DB.	MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties (обязательно)
Теги	Теги ресурсов	Словарь имен и значений тегов. См. теги в шаблонах
тип	Тип ресурса	"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections"

MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties

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

MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource

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

MongoIndex

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

MongoIndexKeys

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

MongoIndexOptions

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

ResourceRestoreParameters

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

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@2024-12-01-preview"
  name = "string"
  identity = {
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
      }
    }
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  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"
          restoreWithTtlDisabled = bool
        }
        shardKey = {
          {customized property} = "string"
        }
      }
    }
  })
}

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

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

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

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

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

CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions

Имя	Описание	Ценность
autoscaleSettings	Задает параметры автомасштабирования. Примечание. Требуется либо пропускная способность, либо автомасштабированиеSettings, но не оба.	AutoscaleSettings
производительность	Единицы запроса в секунду. Например, "пропускная способность": 10000.	int

ManagedServiceIdentity

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

ManagedServiceIdentityUserAssignedIdentities

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

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections

Имя	Описание	Ценность
тождество	Удостоверение ресурса.	ManagedServiceIdentity
местоположение	Расположение группы ресурсов, к которой принадлежит ресурс.	струна
имя	Имя ресурса	строка (обязательно)
parent_id	Идентификатор ресурса, который является родительским для этого ресурса.	Идентификатор ресурса типа: databaseAccounts/mongodbDatabases
свойства	Свойства для создания и обновления коллекции MongoDB Azure Cosmos DB.	MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties (обязательно)
Теги	Теги ресурсов	Словарь имен и значений тегов.
тип	Тип ресурса	"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2024-12-01-preview"

MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties

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

MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource

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

MongoIndex

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

MongoIndexKeys

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

MongoIndexOptions

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

ResourceRestoreParameters

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

ShardKeys

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

Теги

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