Определение ресурсов Bicep
Тип ресурса databaseAccounts/mongodbDatabases/collections можно развернуть с помощью операций, предназначенных для следующих операций:
Список измененных свойств в каждой версии API см. в журнала изменений.
Чтобы создать ресурс Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections, добавьте следующий Bicep в шаблон.
resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2025-05-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'
}
}
Значения свойств
Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections
АвтомасштабированиеSettings
| Имя |
Описание |
Ценность |
| maxПропускная способность |
Представляет максимальную пропускную способность, ресурс может масштабироваться до. |
инт |
Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties
CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions
| Имя |
Описание |
Ценность |
| autoscaleSettings |
Задает параметры автомасштабирования. Примечание. Требуется либо пропускная способность, либо автомасштабированиеSettings, но не оба. |
АвтомасштабированиеSettings |
| производительность |
Единицы запроса в секунду. Например, "пропускная способность": 10000. |
инт |
Управляемая служебная идентичность
| Имя |
Описание |
Ценность |
| тип |
Тип удостоверения, используемого для ресурса. Тип SystemAssigned,UserAssigned включает как неявное созданное удостоверение, так и набор назначенных пользователем удостоверений. Тип "Нет" удаляет все удостоверения из службы. |
"Нет"
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned |
| ИдентичностиНазначенныеПользователем |
Список удостоверений пользователей, связанных с ресурсом. Ссылки на ключ словаря удостоверений пользователя будут идентификаторами ресурсов ARM в форме: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". |
ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties
MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource
| Имя |
Описание |
Ценность |
| analyticStorageTtl |
Аналитический TTL. |
инт |
| createMode |
Перечисление, указывающее режим создания ресурсов. |
По умолчанию
"Восстановить" |
| идентификатор |
Имя коллекции MongoDB Cosmos DB |
строка (обязательно) |
| Индексы |
Список ключей индекса |
MongoIndex[] |
| restoreParameters |
Параметры для указания сведений о восстановлении |
ResourceRestoreParameters (Параметры восстановления) |
| shardKey |
Пара "ключ-значение" ключей сегментов, применяемая для запроса. |
ШардКлючи |
МонгоИндекс
| Имя |
Описание |
Ценность |
| ключ |
Ключи индекса коллекции MongoDB Cosmos DB |
MongoIndexKeys |
| Параметры |
Параметры ключа индекса индекса коллекции Cosmos DB MongoDB |
MongoIndexOptions |
MongoIndexKeys
| Имя |
Описание |
Ценность |
| Ключи |
Список ключей для каждой коллекции MongoDB в службе Azure Cosmos DB |
строка[] |
MongoIndexOptions
| Имя |
Описание |
Ценность |
| expireAfterSeconds |
Срок действия через секунды |
инт |
| уникальный |
Уникально или нет |
булевая переменная (bool) |
ResourceRestoreParameters (Параметры восстановления)
| Имя |
Описание |
Ценность |
| restoreSource |
Идентификатор учетной записи базы данных, из которой необходимо инициировать восстановление. Например: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/location/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} |
струна |
| restoreTimestampInUtc |
Время восстановления учетной записи (формат ISO-8601). |
струна |
| restoreWithTtlDisabled |
Указывает, будет ли восстановленная учетная запись иметь время-To-Live отключена при успешном восстановлении. |
булевая переменная (bool) |
ШардКлючи
Примеры использования
Примеры быстрого запуска Azure
Следующие шаблоны быстрого запуска Azure содержат примеры Bicep для развертывания этого типа ресурса.
Определение ресурса шаблона ARM
Тип ресурса databaseAccounts/mongodbDatabases/collections можно развернуть с помощью операций, предназначенных для следующих операций:
Список измененных свойств в каждой версии API см. в журнала изменений.
Чтобы создать ресурс Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections, добавьте следующий код JSON в шаблон.
{
"type": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections",
"apiVersion": "2025-05-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"
}
}
Значения свойств
Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections
АвтомасштабированиеSettings
| Имя |
Описание |
Ценность |
| maxПропускная способность |
Представляет максимальную пропускную способность, ресурс может масштабироваться до. |
инт |
Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties
CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions
| Имя |
Описание |
Ценность |
| autoscaleSettings |
Задает параметры автомасштабирования. Примечание. Требуется либо пропускная способность, либо автомасштабированиеSettings, но не оба. |
АвтомасштабированиеSettings |
| производительность |
Единицы запроса в секунду. Например, "пропускная способность": 10000. |
инт |
Управляемая служебная идентичность
| Имя |
Описание |
Ценность |
| тип |
Тип удостоверения, используемого для ресурса. Тип SystemAssigned,UserAssigned включает как неявное созданное удостоверение, так и набор назначенных пользователем удостоверений. Тип "Нет" удаляет все удостоверения из службы. |
"Нет"
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned |
| ИдентичностиНазначенныеПользователем |
Список удостоверений пользователей, связанных с ресурсом. Ссылки на ключ словаря удостоверений пользователя будут идентификаторами ресурсов ARM в форме: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". |
ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties
MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource
| Имя |
Описание |
Ценность |
| analyticStorageTtl |
Аналитический TTL. |
инт |
| createMode |
Перечисление, указывающее режим создания ресурсов. |
По умолчанию
"Восстановить" |
| идентификатор |
Имя коллекции MongoDB Cosmos DB |
строка (обязательно) |
| Индексы |
Список ключей индекса |
MongoIndex[] |
| restoreParameters |
Параметры для указания сведений о восстановлении |
ResourceRestoreParameters (Параметры восстановления) |
| shardKey |
Пара "ключ-значение" ключей сегментов, применяемая для запроса. |
ШардКлючи |
МонгоИндекс
| Имя |
Описание |
Ценность |
| ключ |
Ключи индекса коллекции MongoDB Cosmos DB |
MongoIndexKeys |
| Параметры |
Параметры ключа индекса индекса коллекции Cosmos DB MongoDB |
MongoIndexOptions |
MongoIndexKeys
| Имя |
Описание |
Ценность |
| Ключи |
Список ключей для каждой коллекции MongoDB в службе Azure Cosmos DB |
строка[] |
MongoIndexOptions
| Имя |
Описание |
Ценность |
| expireAfterSeconds |
Срок действия через секунды |
инт |
| уникальный |
Уникально или нет |
булевая переменная (bool) |
ResourceRestoreParameters (Параметры восстановления)
| Имя |
Описание |
Ценность |
| restoreSource |
Идентификатор учетной записи базы данных, из которой необходимо инициировать восстановление. Например: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/location/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} |
струна |
| restoreTimestampInUtc |
Время восстановления учетной записи (формат ISO-8601). |
струна |
| restoreWithTtlDisabled |
Указывает, будет ли восстановленная учетная запись иметь время-To-Live отключена при успешном восстановлении. |
булевая переменная (bool) |
ШардКлючи
Примеры использования
Шаблоны быстрого запуска Azure
Следующие шаблоны быстрого запуска Azure развернуть этот тип ресурса.
Тип ресурса databaseAccounts/mongodbDatabases/collections можно развернуть с помощью операций, предназначенных для следующих операций:
Список измененных свойств в каждой версии API см. в журнала изменений.
Чтобы создать ресурс Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections, добавьте следующий объект Terraform в шаблон.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2025-05-01-preview"
name = "string"
parent_id = "string"
identity {
type = "string"
identity_ids = [
"string"
]
}
location = "string"
tags = {
{customized property} = "string"
}
body = {
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"
}
}
}
}
}
Значения свойств
Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections
АвтомасштабированиеSettings
| Имя |
Описание |
Ценность |
| maxПропускная способность |
Представляет максимальную пропускную способность, ресурс может масштабироваться до. |
инт |
Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties
CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions
| Имя |
Описание |
Ценность |
| autoscaleSettings |
Задает параметры автомасштабирования. Примечание. Требуется либо пропускная способность, либо автомасштабированиеSettings, но не оба. |
АвтомасштабированиеSettings |
| производительность |
Единицы запроса в секунду. Например, "пропускная способность": 10000. |
инт |
Управляемая служебная идентичность
| Имя |
Описание |
Ценность |
| тип |
Тип удостоверения, используемого для ресурса. Тип SystemAssigned,UserAssigned включает как неявное созданное удостоверение, так и набор назначенных пользователем удостоверений. Тип "Нет" удаляет все удостоверения из службы. |
"Нет"
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned |
| ИдентичностиНазначенныеПользователем |
Список удостоверений пользователей, связанных с ресурсом. Ссылки на ключ словаря удостоверений пользователя будут идентификаторами ресурсов ARM в форме: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". |
ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties
MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource
| Имя |
Описание |
Ценность |
| analyticStorageTtl |
Аналитический TTL. |
инт |
| createMode |
Перечисление, указывающее режим создания ресурсов. |
По умолчанию
"Восстановить" |
| идентификатор |
Имя коллекции MongoDB Cosmos DB |
строка (обязательно) |
| Индексы |
Список ключей индекса |
MongoIndex[] |
| restoreParameters |
Параметры для указания сведений о восстановлении |
ResourceRestoreParameters (Параметры восстановления) |
| shardKey |
Пара "ключ-значение" ключей сегментов, применяемая для запроса. |
ШардКлючи |
МонгоИндекс
| Имя |
Описание |
Ценность |
| ключ |
Ключи индекса коллекции MongoDB Cosmos DB |
MongoIndexKeys |
| Параметры |
Параметры ключа индекса индекса коллекции Cosmos DB MongoDB |
MongoIndexOptions |
MongoIndexKeys
| Имя |
Описание |
Ценность |
| Ключи |
Список ключей для каждой коллекции MongoDB в службе Azure Cosmos DB |
строка[] |
MongoIndexOptions
| Имя |
Описание |
Ценность |
| expireAfterSeconds |
Срок действия через секунды |
инт |
| уникальный |
Уникально или нет |
булевая переменная (bool) |
ResourceRestoreParameters (Параметры восстановления)
| Имя |
Описание |
Ценность |
| restoreSource |
Идентификатор учетной записи базы данных, из которой необходимо инициировать восстановление. Например: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/location/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} |
струна |
| restoreTimestampInUtc |
Время восстановления учетной записи (формат ISO-8601). |
струна |
| restoreWithTtlDisabled |
Указывает, будет ли восстановленная учетная запись иметь время-To-Live отключена при успешном восстановлении. |
булевая переменная (bool) |
ШардКлючи
