Microsoft.DocumentDB mongoClusters 2023-09-15-preview
Определение ресурсов Bicep
Тип ресурса MongoClusters можно развернуть с помощью операций, предназначенных для следующих операций:
- группы ресурсов . См. команды развертывания группы ресурсов
Список измененных свойств в каждой версии API см. в журнала изменений.
Формат ресурса
Чтобы создать ресурс Microsoft.DocumentDB/mongoClusters, добавьте следующий Bicep в шаблон.
resource symbolicname 'Microsoft.DocumentDB/mongoClusters@2023-09-15-preview' = {
location: 'string'
name: 'string'
properties: {
administratorLogin: 'string'
administratorLoginPassword: 'string'
createMode: 'string'
nodeGroupSpecs: [
{
diskSizeGB: int
enableHa: bool
kind: 'string'
nodeCount: int
sku: 'string'
}
]
restoreParameters: {
pointInTimeUTC: 'string'
sourceResourceId: 'string'
}
serverVersion: 'string'
}
tags: {
{customized property}: 'string'
}
}
Значения свойств
Microsoft.DocumentDB/mongoClusters
| Имя | Описание | Ценность |
|---|---|---|
| местоположение | Географическое расположение, в котором находится ресурс | строка (обязательно) |
| имя | Имя ресурса | струна Ограничения целостности: Минимальная длина = 3 Максимальная длина = 3 Pattern = ^[a-z0-9]+(-[a-z0-9]+)* (обязательно) |
| свойства | Свойства кластера Mongo. | MongoClusterProperties |
| Теги | Теги ресурсов | Словарь имен и значений тегов. См. теги в шаблонах |
MongoClusterProperties
| Имя | Описание | Ценность |
|---|---|---|
| administratorLogin | Имя входа администратора для кластера Mongo. | струна |
| administratorLoginPassword | Пароль для входа администратора. | струна Ограничения целостности: Конфиденциальное значение. Передайте в качестве безопасного параметра. |
| createMode | Режим создания кластера mongo. | По умолчанию "PointInTimeRestore" "Восстановить" |
| nodeGroupSpecs | Список спецификаций группы узлов в кластере. | NodeGroupSpec[] |
| restoreParameters | Параметры, используемые для операций восстановления | MongoClusterRestoreParameters |
| serverVersion | Версия сервера Mongo DB. По умолчанию используется последняя доступная версия, если она не указана. | струна |
MongoClusterRestoreParameters
| Имя | Описание | Ценность |
|---|---|---|
| pointInTimeUTC | Время в формате UTC для восстановления кластера mongo | струна |
| sourceResourceId | Идентификатор ресурса для поиска исходного кластера для восстановления | струна |
NodeGroupSpec
| Имя | Описание | Ценность |
|---|---|---|
| diskSizeGB | Размер хранилища диска для группы узлов в ГБ. Примеры значений: 128, 256, 512, 1024. | int |
| enableHa | Включена ли высокая доступность в группе узлов. | bool |
| добрый | Тип узла, развернутый в группе узлов. | "Сегмент" |
| nodeCount | Количество узлов в группе узлов. | int |
| SKU | SKU ресурса для группы узлов. Это определяет размер ЦП и памяти, подготовленной для каждого узла. Примеры значений: "M30", "M40". | струна |
TrackedResourceTags
| Имя | Описание | Ценность |
|---|
Определение ресурса шаблона ARM
Тип ресурса MongoClusters можно развернуть с помощью операций, предназначенных для следующих операций:
- группы ресурсов . См. команды развертывания группы ресурсов
Список измененных свойств в каждой версии API см. в журнала изменений.
Формат ресурса
Чтобы создать ресурс Microsoft.DocumentDB/mongoClusters, добавьте следующий код JSON в шаблон.
{
"type": "Microsoft.DocumentDB/mongoClusters",
"apiVersion": "2023-09-15-preview",
"name": "string",
"location": "string",
"properties": {
"administratorLogin": "string",
"administratorLoginPassword": "string",
"createMode": "string",
"nodeGroupSpecs": [
{
"diskSizeGB": "int",
"enableHa": "bool",
"kind": "string",
"nodeCount": "int",
"sku": "string"
}
],
"restoreParameters": {
"pointInTimeUTC": "string",
"sourceResourceId": "string"
},
"serverVersion": "string"
},
"tags": {
"{customized property}": "string"
}
}
Значения свойств
Microsoft.DocumentDB/mongoClusters
| Имя | Описание | Ценность |
|---|---|---|
| apiVersion | Версия API | '2023-09-15-preview' |
| местоположение | Географическое расположение, в котором находится ресурс | строка (обязательно) |
| имя | Имя ресурса | струна Ограничения целостности: Минимальная длина = 3 Максимальная длина = 3 Pattern = ^[a-z0-9]+(-[a-z0-9]+)* (обязательно) |
| свойства | Свойства кластера Mongo. | MongoClusterProperties |
| Теги | Теги ресурсов | Словарь имен и значений тегов. См. теги в шаблонах |
| тип | Тип ресурса | "Microsoft.DocumentDB/mongoClusters" |
MongoClusterProperties
| Имя | Описание | Ценность |
|---|---|---|
| administratorLogin | Имя входа администратора для кластера Mongo. | струна |
| administratorLoginPassword | Пароль для входа администратора. | струна Ограничения целостности: Конфиденциальное значение. Передайте в качестве безопасного параметра. |
| createMode | Режим создания кластера mongo. | По умолчанию "PointInTimeRestore" "Восстановить" |
| nodeGroupSpecs | Список спецификаций группы узлов в кластере. | NodeGroupSpec[] |
| restoreParameters | Параметры, используемые для операций восстановления | MongoClusterRestoreParameters |
| serverVersion | Версия сервера Mongo DB. По умолчанию используется последняя доступная версия, если она не указана. | струна |
MongoClusterRestoreParameters
| Имя | Описание | Ценность |
|---|---|---|
| pointInTimeUTC | Время в формате UTC для восстановления кластера mongo | струна |
| sourceResourceId | Идентификатор ресурса для поиска исходного кластера для восстановления | струна |
NodeGroupSpec
| Имя | Описание | Ценность |
|---|---|---|
| diskSizeGB | Размер хранилища диска для группы узлов в ГБ. Примеры значений: 128, 256, 512, 1024. | int |
| enableHa | Включена ли высокая доступность в группе узлов. | bool |
| добрый | Тип узла, развернутый в группе узлов. | "Сегмент" |
| nodeCount | Количество узлов в группе узлов. | int |
| SKU | SKU ресурса для группы узлов. Это определяет размер ЦП и памяти, подготовленной для каждого узла. Примеры значений: "M30", "M40". | струна |
TrackedResourceTags
| Имя | Описание | Ценность |
|---|
Определение ресурса Terraform (поставщик AzAPI)
Тип ресурса MongoClusters можно развернуть с помощью операций, предназначенных для следующих операций:
- групп ресурсов
Список измененных свойств в каждой версии API см. в журнала изменений.
Формат ресурса
Чтобы создать ресурс Microsoft.DocumentDB/mongoClusters, добавьте следующий объект Terraform в шаблон.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/mongoClusters@2023-09-15-preview"
name = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = jsonencode({
properties = {
administratorLogin = "string"
administratorLoginPassword = "string"
createMode = "string"
nodeGroupSpecs = [
{
diskSizeGB = int
enableHa = bool
kind = "string"
nodeCount = int
sku = "string"
}
]
restoreParameters = {
pointInTimeUTC = "string"
sourceResourceId = "string"
}
serverVersion = "string"
}
})
}
Значения свойств
Microsoft.DocumentDB/mongoClusters
| Имя | Описание | Ценность |
|---|---|---|
| местоположение | Географическое расположение, в котором находится ресурс | строка (обязательно) |
| имя | Имя ресурса | струна Ограничения целостности: Минимальная длина = 3 Максимальная длина = 3 Pattern = ^[a-z0-9]+(-[a-z0-9]+)* (обязательно) |
| свойства | Свойства кластера Mongo. | MongoClusterProperties |
| Теги | Теги ресурсов | Словарь имен и значений тегов. |
| тип | Тип ресурса | "Microsoft.DocumentDB/mongoClusters@2023-09-15-preview" |
MongoClusterProperties
| Имя | Описание | Ценность |
|---|---|---|
| administratorLogin | Имя входа администратора для кластера Mongo. | струна |
| administratorLoginPassword | Пароль для входа администратора. | струна Ограничения целостности: Конфиденциальное значение. Передайте в качестве безопасного параметра. |
| createMode | Режим создания кластера mongo. | По умолчанию "PointInTimeRestore" "Восстановить" |
| nodeGroupSpecs | Список спецификаций группы узлов в кластере. | NodeGroupSpec[] |
| restoreParameters | Параметры, используемые для операций восстановления | MongoClusterRestoreParameters |
| serverVersion | Версия сервера Mongo DB. По умолчанию используется последняя доступная версия, если она не указана. | струна |
MongoClusterRestoreParameters
| Имя | Описание | Ценность |
|---|---|---|
| pointInTimeUTC | Время в формате UTC для восстановления кластера mongo | струна |
| sourceResourceId | Идентификатор ресурса для поиска исходного кластера для восстановления | струна |
NodeGroupSpec
| Имя | Описание | Ценность |
|---|---|---|
| diskSizeGB | Размер хранилища диска для группы узлов в ГБ. Примеры значений: 128, 256, 512, 1024. | int |
| enableHa | Включена ли высокая доступность в группе узлов. | bool |
| добрый | Тип узла, развернутый в группе узлов. | "Сегмент" |
| nodeCount | Количество узлов в группе узлов. | int |
| SKU | SKU ресурса для группы узлов. Это определяет размер ЦП и памяти, подготовленной для каждого узла. Примеры значений: "M30", "M40". | струна |
TrackedResourceTags
| Имя | Описание | Ценность |
|---|