Microsoft.DocumentDB mongoClusters 2024-02-15-preview
Определение ресурса Bicep
Тип ресурса mongoClusters можно развернуть с помощью операций, предназначенных для:
- Группы ресурсов — см. команды развертывания групп ресурсов.
Список измененных свойств в каждой версии API см. в журнале изменений.
Формат ресурсов
Чтобы создать ресурс Microsoft.DocumentDB/mongoClusters, добавьте в шаблон следующий Bicep.
resource symbolicname 'Microsoft.DocumentDB/mongoClusters@2024-02-15-preview' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
properties: {
administratorLogin: 'string'
administratorLoginPassword: 'string'
createMode: 'string'
nodeGroupSpecs: [
{
diskSizeGB: int
enableHa: bool
kind: 'Shard'
nodeCount: int
sku: 'string'
}
]
restoreParameters: {
pointInTimeUTC: 'string'
sourceResourceId: 'string'
}
serverVersion: 'string'
}
}
Значения свойств
mongoClusters
| Имя | Описание | Значение |
|---|---|---|
| name | имя ресурса. | string (обязательно) |
| location | Географическое расположение, в котором находится ресурс | string (обязательно) |
| tags | Теги ресурсов. | Словарь имен и значений тегов. См . раздел Теги в шаблонах |
| properties | Свойства кластера mongo. | MongoClusterProperties |
MongoClusterProperties
| Имя | Описание | Значение |
|---|---|---|
| administratorLogin | Имя входа администратора для кластера mongo. | строка |
| administratorLoginPassword | Пароль для входа администратора. | строка Ограничения: Конфиденциальное значение. Передайте в качестве безопасного параметра. |
| createMode | Режим создания кластера mongo. | 'Default' PointInTimeRestore "Восстановить" |
| nodeGroupSpecs | Список спецификаций группы узлов в кластере. | NodeGroupSpec[] Ограничения: Минимальная длина = 1 |
| restoreParameters | Параметры, используемые для операций восстановления | MongoClusterRestoreParameters |
| serverVersion | Версия сервера Mongo DB. По умолчанию используется последняя доступная версия, если она не указана. | строка |
NodeGroupSpec
| Имя | Описание | Значение |
|---|---|---|
| diskSizeGB | Размер дискового хранилища для группы узлов в ГБ. Примеры значений: 128, 256, 512, 1024. | INT |
| enableHa | Включена ли высокая доступность в группе узлов. | bool |
| kind | Тип узла, развернутый в группе узлов. | "Сегмент" |
| nodeCount | Количество узлов в группе узлов. | INT |
| sku | SKU ресурса для группы узлов. Это определяет размер ЦП и памяти, подготовленных для каждого узла. Примеры значений: "M30", "M40". | строка |
MongoClusterRestoreParameters
| Имя | Описание | Значение |
|---|---|---|
| pointInTimeUTC | Время в формате UTC для восстановления кластера Mongo | строка |
| sourceResourceId | Идентификатор ресурса для поиска исходного кластера для восстановления | строка |
Определение ресурса шаблона ARM
Тип ресурса mongoClusters можно развернуть с помощью операций, предназначенных для:
- Группы ресурсов — см. команды развертывания групп ресурсов.
Список измененных свойств в каждой версии API см. в журнале изменений.
Формат ресурсов
Чтобы создать ресурс Microsoft.DocumentDB/mongoClusters, добавьте следующий код JSON в шаблон.
{
"type": "Microsoft.DocumentDB/mongoClusters",
"apiVersion": "2024-02-15-preview",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"properties": {
"administratorLogin": "string",
"administratorLoginPassword": "string",
"createMode": "string",
"nodeGroupSpecs": [
{
"diskSizeGB": "int",
"enableHa": "bool",
"kind": "Shard",
"nodeCount": "int",
"sku": "string"
}
],
"restoreParameters": {
"pointInTimeUTC": "string",
"sourceResourceId": "string"
},
"serverVersion": "string"
}
}
Значения свойств
mongoClusters
| Имя | Описание | Значение |
|---|---|---|
| тип | Тип ресурса | Microsoft.DocumentDB/mongoClusters |
| версия_API | Версия API ресурсов | '2024-02-15-preview' |
| name | имя ресурса. | string (обязательно) |
| location | Географическое расположение, в котором находится ресурс | string (обязательно) |
| tags | Теги ресурсов. | Словарь имен и значений тегов. См . раздел Теги в шаблонах |
| properties | Свойства кластера mongo. | MongoClusterProperties |
MongoClusterProperties
| Имя | Описание | Значение |
|---|---|---|
| administratorLogin | Имя входа администратора для кластера mongo. | строка |
| administratorLoginPassword | Пароль для входа администратора. | строка Ограничения: Конфиденциальное значение. Передайте в качестве безопасного параметра. |
| createMode | Режим создания кластера mongo. | 'Default' PointInTimeRestore "Восстановить" |
| nodeGroupSpecs | Список спецификаций группы узлов в кластере. | NodeGroupSpec[] Ограничения: Минимальная длина = 1 |
| restoreParameters | Параметры, используемые для операций восстановления | MongoClusterRestoreParameters |
| serverVersion | Версия сервера Mongo DB. По умолчанию используется последняя доступная версия, если она не указана. | строка |
NodeGroupSpec
| Имя | Описание | Значение |
|---|---|---|
| diskSizeGB | Размер дискового хранилища для группы узлов в ГБ. Примеры значений: 128, 256, 512, 1024. | INT |
| enableHa | Включена ли высокая доступность в группе узлов. | bool |
| kind | Тип узла, развернутый в группе узлов. | "Сегмент" |
| nodeCount | Количество узлов в группе узлов. | INT |
| sku | SKU ресурса для группы узлов. Это определяет размер ЦП и памяти, подготовленных для каждого узла. Примеры значений: "M30", "M40". | строка |
MongoClusterRestoreParameters
| Имя | Описание | Значение |
|---|---|---|
| pointInTimeUTC | Время в формате UTC для восстановления кластера Mongo | строка |
| sourceResourceId | Идентификатор ресурса для поиска исходного кластера для восстановления | строка |
Определение ресурса Terraform (поставщик AzAPI)
Тип ресурса mongoClusters можно развернуть с помощью операций, предназначенных для:
- Группы ресурсов
Список измененных свойств в каждой версии API см. в журнале изменений.
Формат ресурсов
Чтобы создать ресурс Microsoft.DocumentDB/mongoClusters, добавьте в шаблон следующую terraform.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/mongoClusters@2024-02-15-preview"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
body = jsonencode({
properties = {
administratorLogin = "string"
administratorLoginPassword = "string"
createMode = "string"
nodeGroupSpecs = [
{
diskSizeGB = int
enableHa = bool
kind = "Shard"
nodeCount = int
sku = "string"
}
]
restoreParameters = {
pointInTimeUTC = "string"
sourceResourceId = "string"
}
serverVersion = "string"
}
})
}
Значения свойств
mongoClusters
| Имя | Описание | Значение |
|---|---|---|
| тип | Тип ресурса | "Microsoft.DocumentDB/mongoClusters@2024-02-15-preview" |
| name | имя ресурса. | строка (обязательно) |
| location | Географическое расположение, в котором находится ресурс | строка (обязательно) |
| parent_id | Чтобы выполнить развертывание в группе ресурсов, используйте идентификатор этой группы ресурсов. | строка (обязательно) |
| tags | Теги ресурсов. | Словарь имен и значений тегов. |
| properties | Свойства кластера mongo. | MongoClusterProperties |
MongoClusterProperties
| Имя | Описание | Значение |
|---|---|---|
| administratorLogin | Имя входа администратора для кластера Mongo. | строка |
| administratorLoginPassword | Пароль для входа администратора. | строка Ограничения: Конфиденциальное значение. Передайте в качестве безопасного параметра. |
| createMode | Режим для создания кластера Mongo. | "По умолчанию" "PointInTimeRestore" "Восстановление" |
| nodeGroupSpecs | Список спецификаций группы узлов в кластере. | NodeGroupSpec[] Ограничения: Минимальная длина = 1 |
| restoreParameters | Параметры, используемые для операций восстановления | MongoClusterRestoreParameters |
| serverVersion | Версия сервера Mongo DB. По умолчанию используется последняя доступная версия, если она не указана. | строка |
NodeGroupSpec
| Имя | Описание | Значение |
|---|---|---|
| diskSizeGB | Размер дискового хранилища для группы узлов в ГБ. Примеры значений: 128, 256, 512, 1024. | INT |
| enableHa | Указывает, включен ли высокий уровень доступности в группе узлов. | bool |
| kind | Тип узла, развернутый в группе узлов. | "Сегмент" |
| nodeCount | Количество узлов в группе узлов. | INT |
| sku | Номер SKU ресурса для группы узлов. Он определяет размер ЦП и памяти, подготовленных для каждого узла. Примеры значений: "M30", "M40". | строка |
MongoClusterRestoreParameters
| Имя | Описание | Значение |
|---|---|---|
| pointInTimeUTC | Время восстановления кластера Mongo в формате UTC | строка |
| sourceResourceId | Идентификатор ресурса для поиска исходного кластера для восстановления | строка |