Microsoft.DocumentDB mongoClusters 2024-10-01-preview
Определение ресурсов Bicep
Тип ресурса MongoClusters можно развернуть с помощью операций, предназначенных для следующих операций:
- группы ресурсов . См. команды развертывания группы ресурсов
Список измененных свойств в каждой версии API см. в журнала изменений.
Формат ресурса
Чтобы создать ресурс Microsoft.DocumentDB/mongoClusters, добавьте следующий Bicep в шаблон.
resource symbolicname 'Microsoft.DocumentDB/mongoClusters@2024-10-01-preview' = {
location: 'string'
name: 'string'
properties: {
administrator: {
password: 'string'
userName: 'string'
}
backup: {}
compute: {
tier: 'string'
}
createMode: 'string'
dataApi: {
mode: 'string'
}
highAvailability: {
targetMode: 'string'
}
previewFeatures: [
'string'
]
publicNetworkAccess: 'string'
replicaParameters: {
sourceLocation: 'string'
sourceResourceId: 'string'
}
restoreParameters: {
pointInTimeUTC: 'string'
sourceResourceId: 'string'
}
serverVersion: 'string'
sharding: {
shardCount: int
}
storage: {
sizeGb: int
}
}
tags: {
{customized property}: 'string'
}
}
Значения свойств
AdministratorProperties
| Имя | Описание | Ценность |
|---|---|---|
| пароль | Пароль администратора. | струна Ограничения целостности: Конфиденциальное значение. Передайте в качестве безопасного параметра. |
| userName | Имя пользователя администратора. | струна |
BackupProperties
| Имя | Описание | Ценность |
|---|
ComputeProperties
| Имя | Описание | Ценность |
|---|---|---|
| ярус | Уровень вычислений, назначаемый кластеру, где каждый уровень сопоставляется с размером виртуального ядра и памяти. Примеры значений: "M30", "M40". | струна |
DataApiProperties
| Имя | Описание | Ценность |
|---|---|---|
| режим | Режим, указывающий, включен ли API данных Mongo для кластера. | "Отключено" "Включено" |
HighAvailabilityProperties
| Имя | Описание | Ценность |
|---|---|---|
| targetMode | Целевой режим высокой доступности, запрошенный для кластера. | "Отключено" "SameZone" ZoneRedundantPreferred |
Microsoft.DocumentDB/mongoClusters
| Имя | Описание | Ценность |
|---|---|---|
| местоположение | Географическое расположение, в котором находится ресурс | строка (обязательно) |
| имя | Имя ресурса | струна Ограничения целостности: Минимальная длина = 3 Максимальная длина = 3 Pattern = ^[a-z0-9]+(-[a-z0-9]+)* (обязательно) |
| свойства | Свойства, относящиеся к ресурсу, для этого ресурса. | MongoClusterProperties |
| Теги | Теги ресурсов | Словарь имен и значений тегов. См. теги в шаблонах |
MongoClusterProperties
| Имя | Описание | Ценность |
|---|---|---|
| администратор | Свойства локального администратора для кластера Mongo. | AdministratorProperties |
| резервная копия | Свойства резервного копирования кластера Mongo. | BackupProperties |
| вычислять | Свойства вычислений кластера Mongo. | ComputeProperties |
| createMode | Режим создания кластера mongo. | По умолчанию "GeoReplica" "PointInTimeRestore" "Реплика" |
| dataApi | Свойства API данных кластера Mongo. | DataApiProperties |
| highAvailability | Свойства высокого уровня доступности кластера Mongo. | HighAvailabilityProperties |
| previewFeatures | Список подключений к частной конечной точке. | Массив строк, содержащий любой из: "GeoReplicas" |
| publicNetworkAccess | Разрешен доступ к общедоступной конечной точке для этого кластера Mongo. | "Отключено" "Включено" |
| репликиParameters | Параметры для создания кластера mongo реплики. | MongoClusterReplicaParameters |
| restoreParameters | Параметры для создания кластера mongo восстановления на определенный момент времени. | MongoClusterRestoreParameters |
| serverVersion | Версия сервера Mongo DB. По умолчанию используется последняя доступная версия, если она не указана. | струна |
| Сегментирования | Свойства сегментирования кластера Mongo. | ShardingProperties |
| хранение | Свойства хранилища кластера Mongo. | StorageProperties |
MongoClusterReplicaParameters
| Имя | Описание | Ценность |
|---|---|---|
| sourceLocation | Расположение исходного кластера | строка (обязательно) |
| sourceResourceId | Идентификатор исходного кластера репликации. | строка (обязательно) |
MongoClusterRestoreParameters
| Имя | Описание | Ценность |
|---|---|---|
| pointInTimeUTC | Время в формате UTC для восстановления кластера mongo | струна |
| sourceResourceId | Идентификатор ресурса для поиска исходного кластера для восстановления | струна |
СегментированиеProperties
| Имя | Описание | Ценность |
|---|---|---|
| shardCount | Количество сегментов для подготовки в кластере. | int |
StorageProperties
| Имя | Описание | Ценность |
|---|---|---|
| sizeGb | Размер диска данных, назначенного каждому серверу. | int |
TrackedResourceTags
| Имя | Описание | Ценность |
|---|
Определение ресурса шаблона ARM
Тип ресурса MongoClusters можно развернуть с помощью операций, предназначенных для следующих операций:
- группы ресурсов . См. команды развертывания группы ресурсов
Список измененных свойств в каждой версии API см. в журнала изменений.
Формат ресурса
Чтобы создать ресурс Microsoft.DocumentDB/mongoClusters, добавьте следующий код JSON в шаблон.
{
"type": "Microsoft.DocumentDB/mongoClusters",
"apiVersion": "2024-10-01-preview",
"name": "string",
"location": "string",
"properties": {
"administrator": {
"password": "string",
"userName": "string"
},
"backup": {
},
"compute": {
"tier": "string"
},
"createMode": "string",
"dataApi": {
"mode": "string"
},
"highAvailability": {
"targetMode": "string"
},
"previewFeatures": [ "string" ],
"publicNetworkAccess": "string",
"replicaParameters": {
"sourceLocation": "string",
"sourceResourceId": "string"
},
"restoreParameters": {
"pointInTimeUTC": "string",
"sourceResourceId": "string"
},
"serverVersion": "string",
"sharding": {
"shardCount": "int"
},
"storage": {
"sizeGb": "int"
}
},
"tags": {
"{customized property}": "string"
}
}
Значения свойств
AdministratorProperties
| Имя | Описание | Ценность |
|---|---|---|
| пароль | Пароль администратора. | струна Ограничения целостности: Конфиденциальное значение. Передайте в качестве безопасного параметра. |
| userName | Имя пользователя администратора. | струна |
BackupProperties
| Имя | Описание | Ценность |
|---|
ComputeProperties
| Имя | Описание | Ценность |
|---|---|---|
| ярус | Уровень вычислений, назначаемый кластеру, где каждый уровень сопоставляется с размером виртуального ядра и памяти. Примеры значений: "M30", "M40". | струна |
DataApiProperties
| Имя | Описание | Ценность |
|---|---|---|
| режим | Режим, указывающий, включен ли API данных Mongo для кластера. | "Отключено" "Включено" |
HighAvailabilityProperties
| Имя | Описание | Ценность |
|---|---|---|
| targetMode | Целевой режим высокой доступности, запрошенный для кластера. | "Отключено" "SameZone" ZoneRedundantPreferred |
Microsoft.DocumentDB/mongoClusters
| Имя | Описание | Ценность |
|---|---|---|
| apiVersion | Версия API | '2024-10-01-preview' |
| местоположение | Географическое расположение, в котором находится ресурс | строка (обязательно) |
| имя | Имя ресурса | струна Ограничения целостности: Минимальная длина = 3 Максимальная длина = 3 Pattern = ^[a-z0-9]+(-[a-z0-9]+)* (обязательно) |
| свойства | Свойства, относящиеся к ресурсу, для этого ресурса. | MongoClusterProperties |
| Теги | Теги ресурсов | Словарь имен и значений тегов. См. теги в шаблонах |
| тип | Тип ресурса | "Microsoft.DocumentDB/mongoClusters" |
MongoClusterProperties
| Имя | Описание | Ценность |
|---|---|---|
| администратор | Свойства локального администратора для кластера Mongo. | AdministratorProperties |
| резервная копия | Свойства резервного копирования кластера Mongo. | BackupProperties |
| вычислять | Свойства вычислений кластера Mongo. | ComputeProperties |
| createMode | Режим создания кластера mongo. | По умолчанию "GeoReplica" "PointInTimeRestore" "Реплика" |
| dataApi | Свойства API данных кластера Mongo. | DataApiProperties |
| highAvailability | Свойства высокого уровня доступности кластера Mongo. | HighAvailabilityProperties |
| previewFeatures | Список подключений к частной конечной точке. | Массив строк, содержащий любой из: "GeoReplicas" |
| publicNetworkAccess | Разрешен доступ к общедоступной конечной точке для этого кластера Mongo. | "Отключено" "Включено" |
| репликиParameters | Параметры для создания кластера mongo реплики. | MongoClusterReplicaParameters |
| restoreParameters | Параметры для создания кластера mongo восстановления на определенный момент времени. | MongoClusterRestoreParameters |
| serverVersion | Версия сервера Mongo DB. По умолчанию используется последняя доступная версия, если она не указана. | струна |
| Сегментирования | Свойства сегментирования кластера Mongo. | ShardingProperties |
| хранение | Свойства хранилища кластера Mongo. | StorageProperties |
MongoClusterReplicaParameters
| Имя | Описание | Ценность |
|---|---|---|
| sourceLocation | Расположение исходного кластера | строка (обязательно) |
| sourceResourceId | Идентификатор исходного кластера репликации. | строка (обязательно) |
MongoClusterRestoreParameters
| Имя | Описание | Ценность |
|---|---|---|
| pointInTimeUTC | Время в формате UTC для восстановления кластера mongo | струна |
| sourceResourceId | Идентификатор ресурса для поиска исходного кластера для восстановления | струна |
СегментированиеProperties
| Имя | Описание | Ценность |
|---|---|---|
| shardCount | Количество сегментов для подготовки в кластере. | int |
StorageProperties
| Имя | Описание | Ценность |
|---|---|---|
| sizeGb | Размер диска данных, назначенного каждому серверу. | int |
TrackedResourceTags
| Имя | Описание | Ценность |
|---|
Определение ресурса Terraform (поставщик AzAPI)
Тип ресурса MongoClusters можно развернуть с помощью операций, предназначенных для следующих операций:
- групп ресурсов
Список измененных свойств в каждой версии API см. в журнала изменений.
Формат ресурса
Чтобы создать ресурс Microsoft.DocumentDB/mongoClusters, добавьте следующий объект Terraform в шаблон.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/mongoClusters@2024-10-01-preview"
name = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = jsonencode({
properties = {
administrator = {
password = "string"
userName = "string"
}
backup = {
}
compute = {
tier = "string"
}
createMode = "string"
dataApi = {
mode = "string"
}
highAvailability = {
targetMode = "string"
}
previewFeatures = [
"string"
]
publicNetworkAccess = "string"
replicaParameters = {
sourceLocation = "string"
sourceResourceId = "string"
}
restoreParameters = {
pointInTimeUTC = "string"
sourceResourceId = "string"
}
serverVersion = "string"
sharding = {
shardCount = int
}
storage = {
sizeGb = int
}
}
})
}
Значения свойств
AdministratorProperties
| Имя | Описание | Ценность |
|---|---|---|
| пароль | Пароль администратора. | струна Ограничения целостности: Конфиденциальное значение. Передайте в качестве безопасного параметра. |
| userName | Имя пользователя администратора. | струна |
BackupProperties
| Имя | Описание | Ценность |
|---|
ComputeProperties
| Имя | Описание | Ценность |
|---|---|---|
| ярус | Уровень вычислений, назначаемый кластеру, где каждый уровень сопоставляется с размером виртуального ядра и памяти. Примеры значений: "M30", "M40". | струна |
DataApiProperties
| Имя | Описание | Ценность |
|---|---|---|
| режим | Режим, указывающий, включен ли API данных Mongo для кластера. | "Отключено" "Включено" |
HighAvailabilityProperties
| Имя | Описание | Ценность |
|---|---|---|
| targetMode | Целевой режим высокой доступности, запрошенный для кластера. | "Отключено" "SameZone" ZoneRedundantPreferred |
Microsoft.DocumentDB/mongoClusters
| Имя | Описание | Ценность |
|---|---|---|
| местоположение | Географическое расположение, в котором находится ресурс | строка (обязательно) |
| имя | Имя ресурса | струна Ограничения целостности: Минимальная длина = 3 Максимальная длина = 3 Pattern = ^[a-z0-9]+(-[a-z0-9]+)* (обязательно) |
| свойства | Свойства, относящиеся к ресурсу, для этого ресурса. | MongoClusterProperties |
| Теги | Теги ресурсов | Словарь имен и значений тегов. |
| тип | Тип ресурса | "Microsoft.DocumentDB/mongoClusters@2024-10-01-preview" |
MongoClusterProperties
| Имя | Описание | Ценность |
|---|---|---|
| администратор | Свойства локального администратора для кластера Mongo. | AdministratorProperties |
| резервная копия | Свойства резервного копирования кластера Mongo. | BackupProperties |
| вычислять | Свойства вычислений кластера Mongo. | ComputeProperties |
| createMode | Режим создания кластера mongo. | По умолчанию "GeoReplica" "PointInTimeRestore" "Реплика" |
| dataApi | Свойства API данных кластера Mongo. | DataApiProperties |
| highAvailability | Свойства высокого уровня доступности кластера Mongo. | HighAvailabilityProperties |
| previewFeatures | Список подключений к частной конечной точке. | Массив строк, содержащий любой из: "GeoReplicas" |
| publicNetworkAccess | Разрешен доступ к общедоступной конечной точке для этого кластера Mongo. | "Отключено" "Включено" |
| репликиParameters | Параметры для создания кластера mongo реплики. | MongoClusterReplicaParameters |
| restoreParameters | Параметры для создания кластера mongo восстановления на определенный момент времени. | MongoClusterRestoreParameters |
| serverVersion | Версия сервера Mongo DB. По умолчанию используется последняя доступная версия, если она не указана. | струна |
| Сегментирования | Свойства сегментирования кластера Mongo. | ShardingProperties |
| хранение | Свойства хранилища кластера Mongo. | StorageProperties |
MongoClusterReplicaParameters
| Имя | Описание | Ценность |
|---|---|---|
| sourceLocation | Расположение исходного кластера | строка (обязательно) |
| sourceResourceId | Идентификатор исходного кластера репликации. | строка (обязательно) |
MongoClusterRestoreParameters
| Имя | Описание | Ценность |
|---|---|---|
| pointInTimeUTC | Время в формате UTC для восстановления кластера mongo | струна |
| sourceResourceId | Идентификатор ресурса для поиска исходного кластера для восстановления | струна |
СегментированиеProperties
| Имя | Описание | Ценность |
|---|---|---|
| shardCount | Количество сегментов для подготовки в кластере. | int |
StorageProperties
| Имя | Описание | Ценность |
|---|---|---|
| sizeGb | Размер диска данных, назначенного каждому серверу. | int |
TrackedResourceTags
| Имя | Описание | Ценность |
|---|