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


Microsoft.DocumentDB databaseAccounts/mongodbDatabases 2021-07-01-preview

Определение ресурса Bicep

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

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

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

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

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/mongodbDatabases@2021-07-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  properties: {
    options: {
      autoscaleSettings: {
        maxThroughput: int
      }
      throughput: int
    }
    resource: {
      id: 'string'
    }
  }
}

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

databaseAccounts/mongodbDatabases

Имя Описание Значение
name имя ресурса.

Узнайте, как задать имена и типы для дочерних ресурсов в Bicep.
строка (обязательно)
location Расположение группы ресурсов, к которой принадлежит ресурс. строка
tags Теги — это список пар "ключ-значение", описывающих ресурс. Эти теги можно использовать при просмотре и группировании ресурсов (между группами). Для ресурса можно указать не более 15 тегов. В каждом теге длина ключа нее должна превышать 128 символов, а длина значения — 256 символов. Например, для типа шаблона по умолчанию задано значение defaultExperience: Cassandra. Текущие значения defaultExperience также включают "Table", "Graph", "DocumentDB" и "MongoDB". Словарь имен и значений тегов. См . раздел Теги в шаблонах
родитель В Bicep можно указать родительский ресурс для дочернего ресурса. Это свойство необходимо добавить только в том случае, если дочерний ресурс объявлен вне родительского ресурса.

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

Управляемое удостоверение службы

Имя Описание Значение
тип Тип удостоверения, используемого для ресурса. Тип SystemAssigned,UserAssigned включает как неявно созданное удостоверение, так и набор удостоверений, назначаемых пользователем. Тип None удалит все удостоверения из службы. "Нет"
SystemAssigned
"SystemAssigned,UserAssigned"
UserAssigned
userAssignedIdentities Список удостоверений пользователей, связанных с ресурсом. Ссылки на ключ словаря удостоверений пользователей будут иметь идентификаторы ресурсов ARM в формате "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Имя Описание Значение
{настроенное свойство} Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

Этот объект не содержит свойств, которые необходимо задать во время развертывания. Все свойства доступны только для чтения.

MongoDBDatabaseCreateUpdatePropertiesOrMongoDBDataba...

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

CreateUpdateOptionsOrMongoDBDatabaseGetPropertiesOpt...

Имя Описание Значение
autoscaleSettings Задает параметры автомасштабирования. АвтомасштабированиеПараметры
throughput Количество запросов в секунду. Например, "пропускная способность": 10000. INT

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

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

MongoDBDatabaseResourceOrMongoDBDatabaseGetPropertie...

Имя Описание Значение
идентификатор Имя базы данных MongoDB Cosmos DB строка (обязательно)

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

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

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

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

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

Определение ресурса шаблона ARM

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

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

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

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

{
  "type": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases",
  "apiVersion": "2021-07-01-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {}
    }
  },
  "properties": {
    "options": {
      "autoscaleSettings": {
        "maxThroughput": "int"
      },
      "throughput": "int"
    },
    "resource": {
      "id": "string"
    }
  }
}

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

databaseAccounts/mongodbDatabases

Имя Описание Значение
тип Тип ресурса Microsoft.DocumentDB/databaseAccounts/mongodbDatabases
версия_API Версия API ресурсов '2021-07-01-preview'
name имя ресурса.

Узнайте, как задать имена и типы для дочерних ресурсов в шаблонах JSON ARM.
строка (обязательно)
location Расположение группы ресурсов, к которой принадлежит ресурс. строка
tags Теги — это список пар "ключ-значение", описывающих ресурс. Эти теги можно использовать при просмотре и группировании ресурсов (между группами). Для ресурса можно указать не более 15 тегов. В каждом теге длина ключа нее должна превышать 128 символов, а длина значения — 256 символов. Например, для типа шаблона по умолчанию задано значение defaultExperience: Cassandra. Текущие значения defaultExperience также включают "Table", "Graph", "DocumentDB" и "MongoDB". Словарь имен и значений тегов. См . раздел Теги в шаблонах
удостоверение Удостоверение ресурса. Управляемое удостоверение службы
properties Свойства для создания и обновления базы данных MongoDB в Azure Cosmos DB. MongoDBDatabaseCreateUpdatePropertiesOrMongoDBDataba... (обязательно)

Управляемое удостоверение службы

Имя Описание Значение
тип Тип удостоверения, используемого для ресурса. Тип SystemAssigned,UserAssigned включает как неявно созданное удостоверение, так и набор удостоверений, назначаемых пользователем. Тип None удалит все удостоверения из службы. "Нет"
SystemAssigned
"SystemAssigned,UserAssigned"
UserAssigned
userAssignedIdentities Список удостоверений пользователей, связанных с ресурсом. Ссылки на ключ словаря удостоверений пользователей будут иметь идентификаторы ресурсов ARM в формате "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Имя Описание Значение
{настроенное свойство} Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

Этот объект не содержит свойств, которые необходимо задать во время развертывания. Все свойства доступны только для чтения.

MongoDBDatabaseCreateUpdatePropertiesOrMongoDBDataba...

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

CreateUpdateOptionsOrMongoDBDatabaseGetPropertiesOpt...

Имя Описание Значение
autoscaleSettings Задает параметры автомасштабирования. АвтомасштабированиеПараметры
throughput Количество запросов в секунду. Например, "пропускная способность": 10000. INT

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

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

MongoDBDatabaseResourceOrMongoDBDatabaseGetPropertie...

Имя Описание Значение
идентификатор Имя базы данных MongoDB Cosmos DB строка (обязательно)

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

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

Шаблон Описание
Создание учетной записи 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@2021-07-01-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "string"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      options = {
        autoscaleSettings = {
          maxThroughput = int
        }
        throughput = int
      }
      resource = {
        id = "string"
      }
    }
  })
}

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

databaseAccounts/mongodbDatabases

Имя Описание Значение
тип Тип ресурса "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases@2021-07-01-preview"
name имя ресурса. строка (обязательно)
location Расположение группы ресурсов, к которой принадлежит ресурс. строка
parent_id Идентификатор ресурса, который является родительским для этого ресурса. Идентификатор ресурса типа databaseAccounts
tags Теги — это список пар "ключ-значение", описывающих ресурс. Эти теги можно использовать при просмотре и группировании ресурсов (между группами). Для ресурса можно указать не более 15 тегов. В каждом теге длина ключа нее должна превышать 128 символов, а длина значения — 256 символов. Например, для типа шаблона по умолчанию задано значение defaultExperience: Cassandra. Текущие значения defaultExperience также включают "Table", "Graph", "DocumentDB" и "MongoDB". Словарь имен и значений тегов.
удостоверение Удостоверение ресурса. Управляемое удостоверение службы
properties Свойства для создания и обновления базы данных MongoDB в Azure Cosmos DB. MongoDBDatabaseCreateUpdatePropertiesOrMongoDBDataba... (обязательно)

Управляемое удостоверение службы

Имя Описание Значение
тип Тип удостоверения, используемого для ресурса. Тип SystemAssigned,UserAssigned включает как неявно созданное удостоверение, так и набор удостоверений, назначаемых пользователем. Тип None удалит все удостоверения из службы. "SystemAssigned"
"SystemAssigned,UserAssigned"
UserAssigned
identity_ids Список удостоверений пользователей, связанных с ресурсом. Ссылки на ключ словаря удостоверений пользователей будут иметь идентификаторы ресурсов ARM в формате "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". Массив идентификаторов удостоверений пользователей.

ManagedServiceIdentityUserAssignedIdentities

Имя Описание Значение
{настроенное свойство} Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

Этот объект не содержит свойств, которые необходимо задать во время развертывания. Все свойства доступны только для чтения.

MongoDBDatabaseCreateUpdatePropertiesOrMongoDBDataba...

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

CreateUpdateOptionsOrMongoDBDatabaseGetPropertiesOpt...

Имя Описание Значение
autoscaleSettings Задает параметры автомасштабирования. АвтомасштабированиеПараметры
throughput Количество запросов в секунду. Например, "пропускная способность": 10000. INT

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

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

MongoDBDatabaseResourceOrMongoDBDatabaseGetPropertie...

Имя Описание Значение
идентификатор Имя базы данных MongoDB Cosmos DB строка (обязательно)