База данных Microsoft.DocumentDBAccounts/mongodbDatabases 2024-12-01-preview

Статья
12/21/2024

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

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

группы ресурсов . См. команды развертывания группы ресурсов

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

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

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

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/mongodbDatabases@2024-12-01-preview' = {
  parent: resourceSymbolicName
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  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

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

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

CreateUpdateOptionsOrMongoDBDatabaseGetPropertiesOptions

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

ManagedServiceIdentity

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

ManagedServiceIdentityUserAssignedIdentities

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

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases

Имя	Описание	Ценность
тождество	Удостоверение ресурса.	ManagedServiceIdentity
местоположение	Расположение группы ресурсов, к которой принадлежит ресурс.	струна
имя	Имя ресурса	строка (обязательно)
родитель	В 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-12-01-preview",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "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

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

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

CreateUpdateOptionsOrMongoDBDatabaseGetPropertiesOptions

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

ManagedServiceIdentity

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

ManagedServiceIdentityUserAssignedIdentities

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

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases

Имя	Описание	Ценность
apiVersion	Версия API	'2024-12-01-preview'
тождество	Удостоверение ресурса.	ManagedServiceIdentity
местоположение	Расположение группы ресурсов, к которой принадлежит ресурс.	струна
имя	Имя ресурса	строка (обязательно)
свойства	Свойства для создания и обновления базы данных 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 Cosmos DB для API MongoDB 4.2 в двух регионах с использованием общей и выделенной пропускной способности с двумя коллекциями.
создание учетной записи Azure Cosmos для автомасштабирования API MongoDB развертывание	Этот шаблон создает учетную запись 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-12-01-preview"
  name = "string"
  identity = {
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
      }
    }
  }
  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

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

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

CreateUpdateOptionsOrMongoDBDatabaseGetPropertiesOptions

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

ManagedServiceIdentity

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

ManagedServiceIdentityUserAssignedIdentities

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

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases

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

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

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

База данных Microsoft.DocumentDBAccounts/mongodbDatabases 2024-12-01-preview

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

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

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

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

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

CreateUpdateOptionsOrMongoDBDatabaseGetPropertiesOptions

ManagedServiceIdentity

ManagedServiceIdentityUserAssignedIdentities

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases

MongoDBDatabaseCreateUpdatePropertiesOrMongoDBDatabaseGetProperties

MongoDBDatabaseResourceOrMongoDBDatabaseGetPropertiesResource

ResourceRestoreParameters

Теги

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

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

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

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

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

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

CreateUpdateOptionsOrMongoDBDatabaseGetPropertiesOptions

ManagedServiceIdentity

ManagedServiceIdentityUserAssignedIdentities

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases

MongoDBDatabaseCreateUpdatePropertiesOrMongoDBDatabaseGetProperties

MongoDBDatabaseResourceOrMongoDBDatabaseGetPropertiesResource

ResourceRestoreParameters

Теги

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

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

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

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

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

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

CreateUpdateOptionsOrMongoDBDatabaseGetPropertiesOptions

ManagedServiceIdentity

ManagedServiceIdentityUserAssignedIdentities

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases

MongoDBDatabaseCreateUpdatePropertiesOrMongoDBDatabaseGetProperties

MongoDBDatabaseResourceOrMongoDBDatabaseGetPropertiesResource

ResourceRestoreParameters

Теги

Обратная связь

Дополнительные ресурсы