Поделиться через

База данных Microsoft.DocumentDBAccounts/mongodbDatabases 2024-08-15

  • Статья

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

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

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

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

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

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/mongodbDatabases@2024-08-15' = {
  parent: resourceSymbolicName
  location: 'string'
  name: 'string'
  properties: {
    options: {
      autoscaleSettings: {
        maxThroughput: int
      }
      throughput: int
    }
    resource: {
      createMode: 'string'
      id: 'string'
      restoreParameters: {
        restoreSource: 'string'
        restoreTimestampInUtc: 'string'
        restoreWithTtlDisabled: bool
      }
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

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

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

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

CreateUpdateOptionsOrMongoDBDatabaseGetPropertiesOptions

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

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases

Имя Описание Ценность
местоположение Расположение группы ресурсов, к которой принадлежит ресурс. струна
имя Имя ресурса строка (обязательно)
родитель В Bicep можно указать родительский ресурс для дочернего ресурса. Это свойство необходимо добавить, только если дочерний ресурс объявлен за пределами родительского ресурса.

Дополнительные сведения см. в разделе Дочерний ресурс за пределами родительского ресурса.		 Символьное имя ресурса типа: databaseAccounts
свойства Свойства для создания и обновления базы данных MongoDB Azure Cosmos DB. MongoDBDatabaseCreateUpdatePropertiesOrMongoDBDatabaseGetProperties (обязательно)
Теги Теги ресурсов Словарь имен и значений тегов. См. теги в шаблонах

MongoDBDatabaseCreateUpdatePropertiesOrMongoDBDatabaseGetProperties

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

MongoDBDatabaseResourceOrMongoDBDatabaseGetPropertiesResource

Имя Описание Ценность
createMode Перечисление, указывающее режим создания ресурсов. По умолчанию
"Восстановить"
идентификатор Имя базы данных MongoDB Cosmos DB строка (обязательно)
restoreParameters Параметры для указания сведений о восстановлении ResourceRestoreParameters

ResourceRestoreParameters

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

Теги

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

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

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

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 можно развернуть с помощью операций, предназначенных для следующих операций:

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

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

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

{
  "type": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases",
  "apiVersion": "2024-08-15",
  "name": "string",
  "location": "string",
  "properties": {
    "options": {
      "autoscaleSettings": {
        "maxThroughput": "int"
      },
      "throughput": "int"
    },
    "resource": {
      "createMode": "string",
      "id": "string",
      "restoreParameters": {
        "restoreSource": "string",
        "restoreTimestampInUtc": "string",
        "restoreWithTtlDisabled": "bool"
      }
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

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

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

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

CreateUpdateOptionsOrMongoDBDatabaseGetPropertiesOptions

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

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases

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

MongoDBDatabaseCreateUpdatePropertiesOrMongoDBDatabaseGetProperties

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

MongoDBDatabaseResourceOrMongoDBDatabaseGetPropertiesResource

Имя Описание Ценность
createMode Перечисление, указывающее режим создания ресурсов. По умолчанию
"Восстановить"
идентификатор Имя базы данных MongoDB Cosmos DB строка (обязательно)
restoreParameters Параметры для указания сведений о восстановлении ResourceRestoreParameters

ResourceRestoreParameters

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

Теги

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

Шаблоны быстрого запуска

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

Шаблон Описание
создание учетной записи Azure Cosmos для API MongoDB

развертывание в Azure		 Этот шаблон создает учетную запись Azure Cosmos DB для API MongoDB 4.2 в двух регионах с использованием общей и выделенной пропускной способности с двумя коллекциями.
создание учетной записи Azure Cosmos для автомасштабирования API MongoDB

развертывание в Azure		 Этот шаблон создает учетную запись Azure Cosmos DB для API MongoDB 4.2 в двух регионах, используя общую и выделенную пропускную способность автомасштабирования.

Определение ресурса Terraform (поставщик AzAPI)

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

  • групп ресурсов

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

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

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases@2024-08-15"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      options = {
        autoscaleSettings = {
          maxThroughput = int
        }
        throughput = int
      }
      resource = {
        createMode = "string"
        id = "string"
        restoreParameters = {
          restoreSource = "string"
          restoreTimestampInUtc = "string"
          restoreWithTtlDisabled = bool
        }
      }
    }
  })
}

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

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

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

CreateUpdateOptionsOrMongoDBDatabaseGetPropertiesOptions

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

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases

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

MongoDBDatabaseCreateUpdatePropertiesOrMongoDBDatabaseGetProperties

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

MongoDBDatabaseResourceOrMongoDBDatabaseGetPropertiesResource

Имя Описание Ценность
createMode Перечисление, указывающее режим создания ресурсов. По умолчанию
"Восстановить"
идентификатор Имя базы данных MongoDB Cosmos DB строка (обязательно)
restoreParameters Параметры для указания сведений о восстановлении ResourceRestoreParameters

ResourceRestoreParameters

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

Теги

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