База данных Microsoft.DocumentDBAccounts
- последние
- 2024-12-01-preview
- 2024-11-15
- 2024-09-01-preview
- 2024-08-15
- 2024-05-15
- 2024-05-15-preview
- 2024-02-15-preview
- 2023-11-15
- 2023-11-15-preview
- 2023-09-15
- 2023-09-15-preview
- 2023-04-15
- 2023-03-15
- 2023-03-15-preview
- 2023-03-01-preview
- 2022-11-15
- 2022-11-15-preview
- 2022-08-15
- 2022-08-15-preview
- 2022-05-15
- 2022-05-15-preview
- 2022-02-15-preview
- 2021-11-15-preview
- 2021-10-15
- 2021-10-15-preview
- 2021-07-01-preview
- 2021-06-15
- 2021-05-15
- 2021-04-15
- 2021-04-01-preview
- 2021-03-15
- 2021-03-01-preview
- 2021-01-15
- 2020-09-01
- 2020-06-01-preview
- 2020-04-01
- 2020-03-01
- 2019-12-12
- 2019-08-01
- 2016-03-31
- 2016-03-19
- 2015-11-06
- 2015-04-08
- 2015-04-01
Определение ресурсов Bicep
Тип ресурса databaseAccounts можно развернуть с помощью операций, предназначенных для следующих операций:
- группы ресурсов . См. команды развертывания группы ресурсов
Список измененных свойств в каждой версии API см. в журнала изменений.
Формат ресурса
Чтобы создать ресурс Microsoft.DocumentDB/databaseAccounts, добавьте следующий Bicep в шаблон.
resource symbolicname 'Microsoft.DocumentDB/databaseAccounts@2024-12-01-preview' = {
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
kind: 'string'
location: 'string'
name: 'string'
properties: {
analyticalStorageConfiguration: {
schemaType: 'string'
}
apiProperties: {
serverVersion: 'string'
}
backupPolicy: {
migrationState: {
startTime: 'string'
status: 'string'
targetType: 'string'
}
type: 'string'
// For remaining properties, see BackupPolicy objects
}
capabilities: [
{
name: 'string'
}
]
capacity: {
totalThroughputLimit: int
}
capacityMode: 'string'
connectorOffer: 'string'
consistencyPolicy: {
defaultConsistencyLevel: 'string'
maxIntervalInSeconds: int
maxStalenessPrefix: int
}
cors: [
{
allowedHeaders: 'string'
allowedMethods: 'string'
allowedOrigins: 'string'
exposedHeaders: 'string'
maxAgeInSeconds: int
}
]
createMode: 'string'
customerManagedKeyStatus: 'string'
databaseAccountOfferType: 'Standard'
defaultIdentity: 'string'
defaultPriorityLevel: 'string'
diagnosticLogSettings: {
enableFullTextQuery: 'string'
}
disableKeyBasedMetadataWriteAccess: bool
disableLocalAuth: bool
enableAnalyticalStorage: bool
enableAutomaticFailover: bool
enableBurstCapacity: bool
enableCassandraConnector: bool
enableFreeTier: bool
enableMaterializedViews: bool
enableMultipleWriteLocations: bool
enablePartitionMerge: bool
enablePerRegionPerPartitionAutoscale: bool
enablePriorityBasedExecution: bool
ipRules: [
{
ipAddressOrRange: 'string'
}
]
isVirtualNetworkFilterEnabled: bool
keyVaultKeyUri: 'string'
locations: [
{
failoverPriority: int
isZoneRedundant: bool
locationName: 'string'
}
]
minimalTlsVersion: 'string'
networkAclBypass: 'string'
networkAclBypassResourceIds: [
'string'
]
publicNetworkAccess: 'string'
restoreParameters: {
databasesToRestore: [
{
collectionNames: [
'string'
]
databaseName: 'string'
}
]
gremlinDatabasesToRestore: [
{
databaseName: 'string'
graphNames: [
'string'
]
}
]
restoreMode: 'string'
restoreSource: 'string'
restoreTimestampInUtc: 'string'
restoreWithTtlDisabled: bool
sourceBackupLocation: 'string'
tablesToRestore: [
'string'
]
}
virtualNetworkRules: [
{
id: 'string'
ignoreMissingVNetServiceEndpoint: bool
}
]
}
tags: {
{customized property}: 'string'
}
}
Объекты BackupPolicy
Задайте свойство типа
Для непрерывнойиспользуйте:
{
continuousModeProperties: {
tier: 'string'
}
type: 'Continuous'
}
Для периодического
{
periodicModeProperties: {
backupIntervalInMinutes: int
backupRetentionIntervalInHours: int
backupStorageRedundancy: 'string'
}
type: 'Periodic'
}
Значения свойств
AnalyticStorageConfiguration
| Имя | Описание | Ценность |
|---|---|---|
| schemaType | Описывает типы схемы для аналитического хранилища. | "FullFidelity" 'WellDefined' |
ApiProperties
| Имя | Описание | Ценность |
|---|---|---|
| serverVersion | Описывает версию учетной записи MongoDB. | '3.2' '3.6' '4.0' '4.2' '5.0' '6.0' '7.0' |
BackupPolicy
| Имя | Описание | Ценность |
|---|---|---|
| migrationState | Объект, представляющий состояние миграции между политиками резервного копирования. | BackupPolicyMigrationState |
| тип | Задайте значение "Непрерывный" для типа ContinuousModeBackupPolicy. Задайте значение "Периодический" для типа PeriodicModeBackupPolicy. | "Непрерывный" "Периодический" (обязательный) |
BackupPolicyMigrationState
| Имя | Описание | Ценность |
|---|---|---|
| startTime | Время начала миграции политики резервного копирования (формат ISO-8601). | струна |
| статус | Описывает состояние миграции между типами политик резервного копирования. | "Завершено" "Не удалось" 'InProgress' "Недопустимый" |
| targetType | Описывает тип целевой политики резервного копирования миграции политики резервного копирования. | "Непрерывный" "Периодический" |
Способность
| Имя | Описание | Ценность |
|---|---|---|
| имя | Имя возможности Cosmos DB. Например, "name": "EnableCassandra". Текущие значения также включают EnableTable и EnableGremlin. | струна |
Способность
| Имя | Описание | Ценность |
|---|---|---|
| totalThroughputLimit | Общее ограничение пропускной способности, установленное для учетной записи. Общий объем пропускной способности 2000 года в 2000 году накладывает строгий предел максимальной пропускной способности, который может быть подготовлен для этой учетной записи в 2000 году. Общий объем -1 -1 не ограничивает подготовку пропускной способности. | int Ограничения целостности: Минимальное значение = -1 |
Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties
| Имя | Описание | Ценность |
|---|
ConsistencyPolicy
| Имя | Описание | Ценность |
|---|---|---|
| defaultConsistencyLevel | Уровень согласованности по умолчанию и параметры конфигурации учетной записи Cosmos DB. | 'BoundedStaleness' "ConsistentPrefix" "В конечном итоге" "Сеанс" "Strong" (обязательно) |
| maxIntervalInSeconds | При использовании с уровнем согласованности с ограниченной устаревшей степенью согласованности это значение представляет допустимое время устаревания (в секундах). Допустимый диапазон для этого значения составляет 5 – 86400. Требуется, если для defaultConsistencyPolicy задано значение BoundedStaleness. | int Ограничения целостности: Минимальное значение = 5 Максимальное значение = 86400 |
| maxStalenessPrefix | При использовании с уровнем согласованности с ограниченной устаревшим состоянием это значение представляет количество устаревших запросов, допустимых. Допустимый диапазон для этого значения составляет 1 – 2 147 483 647. Требуется, если для defaultConsistencyPolicy задано значение BoundedStaleness. | int Ограничения целостности: Минимальное значение = 1 Максимальное значение = 2147483647 |
ContinuousModeBackupPolicy
| Имя | Описание | Ценность |
|---|---|---|
| continuousModeProperties | Значения конфигурации для резервного копирования в непрерывном режиме | ContinuousModeProperties |
| тип | Описывает режим резервных копий. | "Непрерывный" (обязательный) |
ContinuousModeProperties
| Имя | Описание | Ценность |
|---|---|---|
| ярус | Перечисление для указания типа режима резервного копирования Continuos | 'Continuous30Days' 'Continuous7Days' |
CorsPolicy
| Имя | Описание | Ценность |
|---|---|---|
| allowedHeaders | Заголовки запроса, указанные в исходном домене, могут указываться в запросе CORS. | струна |
| allowedMethods | Методы (команды HTTP-запроса), которые домен-источник может использовать для запроса CORS. | струна |
| allowedOrigins | Домены источника, которые разрешены запрашивать службу через CORS. | строка (обязательно) |
| exposedHeaders | Заголовки ответа, которые могут быть отправлены в ответ на запрос CORS и предоставляются браузером издателю запроса. | струна |
| maxAgeInSeconds | Максимальное время, которое браузер должен кэшировать запрос preflight OPTIONS. | int Ограничения целостности: Минимальное значение = 1 Максимальное значение = 2147483647 |
DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties
| Имя | Описание | Ценность |
|---|---|---|
| analyticStorageConfiguration | Конкретные свойства аналитического хранилища. | AnalyticStorageConfiguration |
| apiProperties | Определенные свойства API. В настоящее время поддерживается только для API MongoDB. | ApiProperties |
| backupPolicy | Объект, представляющий политику для создания резервных копий в учетной записи. | BackupPolicy |
| Возможности | Список возможностей Cosmos DB для учетной записи | возможности[] |
| способность | Объект, представляющий все свойства, связанные с применением емкости в учетной записи. | емкости |
| capacityMode | Указывает емкостьmode учетной записи Cosmos DB. | "Нет" "Подготовлено" "Бессерверный" |
| connectorOffer | Тип предложения соединителя cassandra для учетной записи базы данных Cosmos DB C*. | "Маленький" |
| consistencyPolicy | Политика согласованности для учетной записи Cosmos DB. | ConsistencyPolicy |
| cors | Политика CORS для учетной записи базы данных Cosmos DB. | CorsPolicy[] |
| createMode | Перечисление, указывающее режим создания учетной записи. | По умолчанию "Восстановить" |
| customerManagedKeyStatus | Указывает состояние функции управляемого клиентом ключа в учетной записи. В случае возникновения ошибок свойство предоставляет рекомендации по устранению неполадок. | струна |
| databaseAccountOfferType | Тип предложения для базы данных | "Стандартный" (обязательный) |
| defaultIdentity | Удостоверение по умолчанию для доступа к хранилищу ключей, используемого в таких функциях, как управляемые клиентом ключи. Удостоверение по умолчанию должно быть явно задано пользователями. Это может быть "FirstPartyIdentity", "SystemAssignedIdentity" и многое другое. | струна |
| defaultPriorityLevel | Перечисление, указывающее уровень приоритета по умолчанию для выполнения на основе приоритета. | "Высокий" "Низкий" |
| diagnosticLogSettings | Объект, представляющий различные параметры журнала диагностики для учетной записи Cosmos DB. | DiagnosticLogSettings |
| disableKeyBasedMetadataWriteAccess | Отключение операций записи с ресурсами метаданных (базами данных, контейнерами, пропускной способностью) с помощью ключей учетной записи | bool |
| disableLocalAuth | Отказ от локальной проверки подлинности и обеспечение использования только MSI и AAD можно использовать исключительно для проверки подлинности. | bool |
| enableAnalyticalStorage | Пометка, указывающее, следует ли включить аналитику хранилища. | bool |
| enableAutomaticFailover | Включает автоматическую отработку отказа области записи в редких случаях, когда регион недоступен из-за сбоя. Автоматическая отработка отказа приведет к новому региону записи для учетной записи и выбирается на основе приоритетов отработки отказа, настроенных для учетной записи. | bool |
| enableBurstCapacity | Флаг, указывающий включение и отключение функции предварительной версии емкости для учетной записи | bool |
| enableCassandraConnector | Включает соединитель cassandra в учетной записи Cosmos DB C* | bool |
| enableFreeTier | Пометка, чтобы указать, включен ли уровень "Бесплатный". | bool |
| enableMaterializedViews | Флаг, указывающий, следует ли включить MaterializedViews в учетной записи Cosmos DB | bool |
| enableMultipleWriteLocations | Позволяет учетной записи записывать в нескольких расположениях | bool |
| enablePartitionMerge | Флаг, указывающий включение и отключение функции слияния секций в учетной записи | bool |
| enablePerRegionPerPartitionAutoscale | Флаг, указывающий включение и отключение Per-Region функции автомасштабирования для секции в учетной записи | bool |
| enablePriorityBasedExecution | Флаг, указывающий включение и отключение функции предварительной версии выполнения на основе приоритета в учетной записи | bool |
| ipRules | Список IpRules. | IpAddressOrRange[] |
| isVirtualNetworkFilterEnabled | Пометка, чтобы указать, следует ли включить или отключить правила ACL виртуальной сети. | bool |
| keyVaultKeyUri | Универсальный код ресурса (URI) хранилища ключей | струна |
| Местонахождения | Массив, содержащий расположения георепликации, включенные для учетной записи Cosmos DB. | расположение[] (обязательно) |
| minTlsVersion | Указывает минимальную разрешенную версию TLS. По умолчанию используется tls 1.0, за исключением Cassandra и API Mongo, которые работают только с TLS 1.2. | Tls Tls11 Tls12 |
| networkAclBypass | Указывает, какие службы разрешены для обхода проверок брандмауэра. | AzureServices "Нет" |
| networkAclBypassResourceIds | Массив, содержащий идентификаторы ресурсов для обхода сетевого списка для учетной записи Cosmos DB. | string[] |
| publicNetworkAccess | Разрешены ли запросы из общедоступной сети | "Отключено" "Включено" 'SecuredByPerimeter' |
| restoreParameters | Параметры для указания сведений о восстановлении. | RestoreParameters |
| virtualNetworkRules | Список правил ACL виртуальной сети, настроенных для учетной записи Cosmos DB. | VirtualNetworkRule[] |
DatabaseRestoreResource
| Имя | Описание | Ценность |
|---|---|---|
| collectionNames | Имена коллекций, доступных для восстановления. | string[] |
| databaseName | Имя базы данных, доступной для восстановления. | струна |
DiagnosticLogSettings
| Имя | Описание | Ценность |
|---|---|---|
| enableFullTextQuery | Описать уровень детализации, с помощью которой необходимо регистрировать запросы. | "False" "Нет" "True" |
GremlinDatabaseRestoreResource
| Имя | Описание | Ценность |
|---|---|---|
| databaseName | Имя базы данных gremlin, доступной для восстановления. | струна |
| GraphNames | Имена графов, доступных для восстановления. | string[] |
IpAddressOrRange
| Имя | Описание | Ценность |
|---|---|---|
| ipAddressOrRange | Один IPv4-адрес или один диапазон адресов IPv4 в формате CIDR. Предоставленные IP-адреса должны быть хорошо форматированы и не могут содержаться в одном из следующих диапазонов: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, так как они не применяются фильтром IP-адресов. Пример допустимых входных данных: "23.40.210.245" или "23.40.210.0/8". | струна |
Местоположение
| Имя | Описание | Ценность |
|---|---|---|
| failoverPriority | Приоритет отработки отказа региона. Приоритет отработки отказа 0 указывает регион записи. Максимальное значение для приоритета отработки отказа = (общее число регионов - 1). Значения приоритета отработки отказа должны быть уникальными для каждого региона, в котором существует учетная запись базы данных. | int Ограничения целостности: Минимальное значение = 0 |
| isZoneRedundant | Флаг, указывающий, является ли этот регион регионом availabilityZone | bool |
| locationName | Имя региона. | струна |
ManagedServiceIdentity
| Имя | Описание | Ценность |
|---|---|---|
| тип | Тип удостоверения, используемого для ресурса. Тип SystemAssigned,UserAssigned включает как неявное созданное удостоверение, так и набор назначенных пользователем удостоверений. Тип "Нет" удаляет все удостоверения из службы. | "Нет" SystemAssigned SystemAssigned, UserAssigned UserAssigned |
| userAssignedIdentities | Список удостоверений пользователей, связанных с ресурсом. Ссылки на ключ словаря удостоверений пользователя будут идентификаторами ресурсов ARM в форме: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". | ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
| Имя | Описание | Ценность |
|---|
Microsoft.DocumentDB/databaseAccounts
| Имя | Описание | Ценность |
|---|---|---|
| тождество | Удостоверение ресурса. | ManagedServiceIdentity |
| добрый | Указывает тип учетной записи базы данных. Это можно задать только при создании учетной записи базы данных. | GlobalDocumentDB MongoDB Синтаксический анализ |
| местоположение | Расположение группы ресурсов, к которой принадлежит ресурс. | струна |
| имя | Имя ресурса | струна Ограничения целостности: Минимальная длина = 3 Максимальная длина = 3 Pattern = ^[a-z0-9]+(-[a-z0-9]+)* (обязательно) |
| свойства | Свойства для создания и обновления учетных записей базы данных Azure Cosmos DB. | DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties (обязательно) |
| Теги | Теги ресурсов | Словарь имен и значений тегов. См. теги в шаблонах |
PeriodicModeBackupPolicy
| Имя | Описание | Ценность |
|---|---|---|
| periodicModeProperties | Значения конфигурации для периодического резервного копирования в режиме | PeriodicModeProperties |
| тип | Описывает режим резервных копий. | "Периодический" (обязательный) |
PeriodicModeProperties
| Имя | Описание | Ценность |
|---|---|---|
| backupIntervalInMinutes | Целое число, представляющее интервал в минутах между двумя резервными копиями | int Ограничения целостности: Минимальное значение = 0 |
| backupRetentionIntervalInHours | Целое число, представляющее время (в часах), которое сохраняется каждой резервной копии. | int Ограничения целостности: Минимальное значение = 0 |
| backupStorageRedundancy | Перечисление, указывающее тип расположения резервного копирования | "Гео" "Local" Зона |
RestoreParameters
| Имя | Описание | Ценность |
|---|---|---|
| databaseToRestore | Список определенных баз данных, доступных для восстановления. | DatabaseRestoreResource[] |
| gremlinDatabasesToRestore | Список конкретных баз данных gremlin, доступных для восстановления. | GremlinDatabaseRestoreResource[] |
| restoreMode | Описывает режим восстановления. | PointInTime |
| restoreSource | Идентификатор учетной записи базы данных, из которой необходимо инициировать восстановление. Например: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/location/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} | струна |
| restoreTimestampInUtc | Время восстановления учетной записи (формат ISO-8601). | струна |
| restoreWithTtlDisabled | Указывает, будет ли восстановленная учетная запись иметь время-To-Live отключена при успешном восстановлении. | bool |
| sourceBackupLocation | Исходное расположение резервного копирования для восстановления. | струна |
| tablesToRestore | Список определенных таблиц, доступных для восстановления. | string[] |
Теги
| Имя | Описание | Ценность |
|---|
VirtualNetworkRule
| Имя | Описание | Ценность |
|---|---|---|
| идентификатор | Идентификатор ресурса подсети, например /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. | струна |
| ignoreMissingVNetServiceEndpoint | Создайте правило брандмауэра до включения конечной точки службы виртуальной сети. | bool |
Примеры краткого руководства
Следующие примеры краткого руководства по развертыванию этого типа ресурса.
| Bicep-файл | Описание |
|---|---|
| API SQL учетной записи Azure Cosmos DB с аналитическим хранилищем | Этот шаблон создает учетную запись Azure Cosmos для API Core (SQL) с базой данных и контейнером, настроенным с помощью аналитического хранилища. |
| учетная запись Azure Cosmos DB с веб-приложением | Этот шаблон развертывает учетную запись Azure Cosmos DB, план службы приложений и создает веб-приложение в плане службы приложений. Он также добавляет два параметра приложения в веб-приложение, ссылающееся на конечную точку учетной записи Azure Cosmos DB. Таким образом решения, развернутые в веб-приложении, могут подключаться к конечной точке учетной записи Azure Cosmos DB с помощью этих параметров. |
| Создание учетной записи Cosmos DB с поддержкой Microsoft Defender | С помощью этого шаблона ARM можно развернуть учетную запись Azure Cosmos DB с включенной поддержкой Microsoft Defender для Azure Cosmos DB. Microsoft Defender для Azure Cosmos DB — это собственный уровень безопасности Azure, который обнаруживает попытки эксплойтировать базы данных в учетных записях Azure Cosmos DB. Microsoft Defender для Azure Cosmos DB обнаруживает потенциальные внедрения SQL, известные плохие субъекты на основе Microsoft Threat Intelligence, подозрительных шаблонов доступа и потенциальных эксплуатации базы данных с помощью скомпрометированных удостоверений или вредоносных участников программы предварительной оценки. |
| Создание учетной записи Azure Cosmos DB уровня "Бесплатный" | Этот шаблон создает бесплатную учетную запись Azure Cosmos DB для API SQL с базой данных с общей пропускной способностью и контейнером. |
| Создание минимальной учетной записи Azure Cosmos DB для API Core (SQL) | Этот шаблон создает учетную запись Azure Cosmos DB для API Core (SQL), указывая только минимальные обязательные свойства ресурса. |
| Создание бессерверной учетной записи Azure Cosmos DB для API SQL | Этот шаблон создает бессерверную учетную запись Azure Cosmos DB для API Core (SQL). |
| создание учетной записи Azure Cosmos и веб-приложения Azure | Этот шаблон создает учетную запись Azure Cosmos, внедряет конечную точку и ключи Cosmos DB в параметры веб-приложения Azure, а затем развертывает веб-приложение ASP MVC из GitHub. |
| создание учетной записи Azure Cosmos для API MongoDB | Этот шаблон создает учетную запись Azure Cosmos DB для API MongoDB 4.2 в двух регионах с использованием общей и выделенной пропускной способности с двумя коллекциями. |
| создание учетной записи Azure Cosmos для автомасштабирования API MongoDB | Этот шаблон создает учетную запись Azure Cosmos DB для API MongoDB 4.2 в двух регионах, используя общую и выделенную пропускную способность автомасштабирования. |
| создание учетной записи Azure Cosmos для API таблиц | Этот шаблон создает учетную запись Azure Cosmos DB для API таблиц в двух регионах и одну таблицу с подготовленной пропускной способностью. |
| Создание учетной записи Azure Cosmos для API таблиц с автомасштабированием | Этот шаблон создает учетную запись Azure Cosmos DB для API таблиц в двух регионах и одну таблицу с пропускной способностью автомасштабирования. |
| создание учетной записи Azure Cosmos DB для API Cassandra | Этот шаблон создает учетную запись Azure Cosmos DB для API Cassandra в двух регионах с пространством ключей и таблицей с выделенной пропускной способностью. |
| создание учетной записи Azure Cosmos DB для API Core (SQL) | Этот шаблон создает учетную запись Azure Cosmos для API Core (SQL) с базой данных и контейнером с пропускной способностью с несколькими другими параметрами. |
| Создание учетной записи Azure Cosmos DB для API Gremlin | Этот шаблон создает учетную запись Azure Cosmos DB для API Gremlin в двух регионах с одной базой данных и одним графом с выделенной пропускной способностью. |
| Создание учетной записи Azure Cosmos DB для автомасштабирования API Gremlin | Этот шаблон создает учетную запись Azure Cosmos DB для API Gremlin в двух регионах с одной базой данных и одним графом с помощью пропускной способности автомасштабирования. |
| Создание учетной записи Azure Cosmos DB в нескольких регионах | Этот шаблон создает учетную запись Azure Cosmos DB для любого типа API базы данных с основным и вторичным регионом с выбором уровня согласованности и типа отработки отказа. |
| создание API SQL учетной записи Azure Cosmos DB с автомасштабированием | Этот шаблон создает учетную запись Azure Cosmos для API Core (SQL) с базой данных и контейнером с пропускной способностью автомасштабирования с несколькими другими параметрами. |
| Создание учетной записи Azure Cosmos DB с частной конечной точкой | Этот шаблон создаст учетную запись Cosmos, виртуальную сеть и частную конечную точку, предоставляющую учетную запись Cosmos виртуальной сети. |
| создание учетной записи SQL Azure Cosmos DB с уровня данных | Этот шаблон создаст учетную запись SQL Cosmos, собственное определение роли и собственное назначение ролей для удостоверения AAD. |
| создание учетной записи Azure CosmosDB | Этот шаблон ARM предназначен для быстрого создания учетной записи CosmosDB с минимальными необходимыми значениями. |
| Создание учетной записи azure Cosmos DB автомасштабирования для API Cassandra | Этот шаблон создает учетную запись Azure Cosmos DB для API Cassandra в двух регионах с пространством ключей и таблицей с пропускной способностью автомасштабирования. |
| Создание хранимых процедур API Azure Cosmos DB Core (SQL) | Этот шаблон создает учетную запись Azure Cosmos DB для API Core (SQL) и контейнер с хранимой процедурой, триггером и определяемой пользователем функцией. |
| создает приложение микрослужб Dapr с помощью приложений контейнеров | Создайте приложение микрослужб Dapr с помощью контейнерных приложений. |
| Создает приложение dapr pub-sub servicebus с помощью приложений контейнеров | Создайте приложение dapr pub-sub servicebus с помощью контейнерных приложений. |
| Развертывание базы данных Azure Data Explorer с помощью подключения Cosmos DB | Разверните базу данных Azure Data Explorer с подключением Cosmos DB. |
Определение ресурса шаблона ARM
Тип ресурса databaseAccounts можно развернуть с помощью операций, предназначенных для следующих операций:
- группы ресурсов . См. команды развертывания группы ресурсов
Список измененных свойств в каждой версии API см. в журнала изменений.
Формат ресурса
Чтобы создать ресурс Microsoft.DocumentDB/databaseAccounts, добавьте следующий код JSON в шаблон.
{
"type": "Microsoft.DocumentDB/databaseAccounts",
"apiVersion": "2024-12-01-preview",
"name": "string",
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
}
}
},
"kind": "string",
"location": "string",
"properties": {
"analyticalStorageConfiguration": {
"schemaType": "string"
},
"apiProperties": {
"serverVersion": "string"
},
"backupPolicy": {
"migrationState": {
"startTime": "string",
"status": "string",
"targetType": "string"
},
"type": "string"
// For remaining properties, see BackupPolicy objects
},
"capabilities": [
{
"name": "string"
}
],
"capacity": {
"totalThroughputLimit": "int"
},
"capacityMode": "string",
"connectorOffer": "string",
"consistencyPolicy": {
"defaultConsistencyLevel": "string",
"maxIntervalInSeconds": "int",
"maxStalenessPrefix": "int"
},
"cors": [
{
"allowedHeaders": "string",
"allowedMethods": "string",
"allowedOrigins": "string",
"exposedHeaders": "string",
"maxAgeInSeconds": "int"
}
],
"createMode": "string",
"customerManagedKeyStatus": "string",
"databaseAccountOfferType": "Standard",
"defaultIdentity": "string",
"defaultPriorityLevel": "string",
"diagnosticLogSettings": {
"enableFullTextQuery": "string"
},
"disableKeyBasedMetadataWriteAccess": "bool",
"disableLocalAuth": "bool",
"enableAnalyticalStorage": "bool",
"enableAutomaticFailover": "bool",
"enableBurstCapacity": "bool",
"enableCassandraConnector": "bool",
"enableFreeTier": "bool",
"enableMaterializedViews": "bool",
"enableMultipleWriteLocations": "bool",
"enablePartitionMerge": "bool",
"enablePerRegionPerPartitionAutoscale": "bool",
"enablePriorityBasedExecution": "bool",
"ipRules": [
{
"ipAddressOrRange": "string"
}
],
"isVirtualNetworkFilterEnabled": "bool",
"keyVaultKeyUri": "string",
"locations": [
{
"failoverPriority": "int",
"isZoneRedundant": "bool",
"locationName": "string"
}
],
"minimalTlsVersion": "string",
"networkAclBypass": "string",
"networkAclBypassResourceIds": [ "string" ],
"publicNetworkAccess": "string",
"restoreParameters": {
"databasesToRestore": [
{
"collectionNames": [ "string" ],
"databaseName": "string"
}
],
"gremlinDatabasesToRestore": [
{
"databaseName": "string",
"graphNames": [ "string" ]
}
],
"restoreMode": "string",
"restoreSource": "string",
"restoreTimestampInUtc": "string",
"restoreWithTtlDisabled": "bool",
"sourceBackupLocation": "string",
"tablesToRestore": [ "string" ]
},
"virtualNetworkRules": [
{
"id": "string",
"ignoreMissingVNetServiceEndpoint": "bool"
}
]
},
"tags": {
"{customized property}": "string"
}
}
Объекты BackupPolicy
Задайте свойство типа
Для непрерывнойиспользуйте:
{
"continuousModeProperties": {
"tier": "string"
},
"type": "Continuous"
}
Для периодического
{
"periodicModeProperties": {
"backupIntervalInMinutes": "int",
"backupRetentionIntervalInHours": "int",
"backupStorageRedundancy": "string"
},
"type": "Periodic"
}
Значения свойств
AnalyticStorageConfiguration
| Имя | Описание | Ценность |
|---|---|---|
| schemaType | Описывает типы схемы для аналитического хранилища. | "FullFidelity" 'WellDefined' |
ApiProperties
| Имя | Описание | Ценность |
|---|---|---|
| serverVersion | Описывает версию учетной записи MongoDB. | '3.2' '3.6' '4.0' '4.2' '5.0' '6.0' '7.0' |
BackupPolicy
| Имя | Описание | Ценность |
|---|---|---|
| migrationState | Объект, представляющий состояние миграции между политиками резервного копирования. | BackupPolicyMigrationState |
| тип | Задайте значение "Непрерывный" для типа ContinuousModeBackupPolicy. Задайте значение "Периодический" для типа PeriodicModeBackupPolicy. | "Непрерывный" "Периодический" (обязательный) |
BackupPolicyMigrationState
| Имя | Описание | Ценность |
|---|---|---|
| startTime | Время начала миграции политики резервного копирования (формат ISO-8601). | струна |
| статус | Описывает состояние миграции между типами политик резервного копирования. | "Завершено" "Не удалось" 'InProgress' "Недопустимый" |
| targetType | Описывает тип целевой политики резервного копирования миграции политики резервного копирования. | "Непрерывный" "Периодический" |
Способность
| Имя | Описание | Ценность |
|---|---|---|
| имя | Имя возможности Cosmos DB. Например, "name": "EnableCassandra". Текущие значения также включают EnableTable и EnableGremlin. | струна |
Способность
| Имя | Описание | Ценность |
|---|---|---|
| totalThroughputLimit | Общее ограничение пропускной способности, установленное для учетной записи. Общий объем пропускной способности 2000 года в 2000 году накладывает строгий предел максимальной пропускной способности, который может быть подготовлен для этой учетной записи в 2000 году. Общий объем -1 -1 не ограничивает подготовку пропускной способности. | int Ограничения целостности: Минимальное значение = -1 |
Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties
| Имя | Описание | Ценность |
|---|
ConsistencyPolicy
| Имя | Описание | Ценность |
|---|---|---|
| defaultConsistencyLevel | Уровень согласованности по умолчанию и параметры конфигурации учетной записи Cosmos DB. | 'BoundedStaleness' "ConsistentPrefix" "В конечном итоге" "Сеанс" "Strong" (обязательно) |
| maxIntervalInSeconds | При использовании с уровнем согласованности с ограниченной устаревшей степенью согласованности это значение представляет допустимое время устаревания (в секундах). Допустимый диапазон для этого значения составляет 5 – 86400. Требуется, если для defaultConsistencyPolicy задано значение BoundedStaleness. | int Ограничения целостности: Минимальное значение = 5 Максимальное значение = 86400 |
| maxStalenessPrefix | При использовании с уровнем согласованности с ограниченной устаревшим состоянием это значение представляет количество устаревших запросов, допустимых. Допустимый диапазон для этого значения составляет 1 – 2 147 483 647. Требуется, если для defaultConsistencyPolicy задано значение BoundedStaleness. | int Ограничения целостности: Минимальное значение = 1 Максимальное значение = 2147483647 |
ContinuousModeBackupPolicy
| Имя | Описание | Ценность |
|---|---|---|
| continuousModeProperties | Значения конфигурации для резервного копирования в непрерывном режиме | ContinuousModeProperties |
| тип | Описывает режим резервных копий. | "Непрерывный" (обязательный) |
ContinuousModeProperties
| Имя | Описание | Ценность |
|---|---|---|
| ярус | Перечисление для указания типа режима резервного копирования Continuos | 'Continuous30Days' 'Continuous7Days' |
CorsPolicy
| Имя | Описание | Ценность |
|---|---|---|
| allowedHeaders | Заголовки запроса, указанные в исходном домене, могут указываться в запросе CORS. | струна |
| allowedMethods | Методы (команды HTTP-запроса), которые домен-источник может использовать для запроса CORS. | струна |
| allowedOrigins | Домены источника, которые разрешены запрашивать службу через CORS. | строка (обязательно) |
| exposedHeaders | Заголовки ответа, которые могут быть отправлены в ответ на запрос CORS и предоставляются браузером издателю запроса. | струна |
| maxAgeInSeconds | Максимальное время, которое браузер должен кэшировать запрос preflight OPTIONS. | int Ограничения целостности: Минимальное значение = 1 Максимальное значение = 2147483647 |
DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties
| Имя | Описание | Ценность |
|---|---|---|
| analyticStorageConfiguration | Конкретные свойства аналитического хранилища. | AnalyticStorageConfiguration |
| apiProperties | Определенные свойства API. В настоящее время поддерживается только для API MongoDB. | ApiProperties |
| backupPolicy | Объект, представляющий политику для создания резервных копий в учетной записи. | BackupPolicy |
| Возможности | Список возможностей Cosmos DB для учетной записи | возможности[] |
| способность | Объект, представляющий все свойства, связанные с применением емкости в учетной записи. | емкости |
| capacityMode | Указывает емкостьmode учетной записи Cosmos DB. | "Нет" "Подготовлено" "Бессерверный" |
| connectorOffer | Тип предложения соединителя cassandra для учетной записи базы данных Cosmos DB C*. | "Маленький" |
| consistencyPolicy | Политика согласованности для учетной записи Cosmos DB. | ConsistencyPolicy |
| cors | Политика CORS для учетной записи базы данных Cosmos DB. | CorsPolicy[] |
| createMode | Перечисление, указывающее режим создания учетной записи. | По умолчанию "Восстановить" |
| customerManagedKeyStatus | Указывает состояние функции управляемого клиентом ключа в учетной записи. В случае возникновения ошибок свойство предоставляет рекомендации по устранению неполадок. | струна |
| databaseAccountOfferType | Тип предложения для базы данных | "Стандартный" (обязательный) |
| defaultIdentity | Удостоверение по умолчанию для доступа к хранилищу ключей, используемого в таких функциях, как управляемые клиентом ключи. Удостоверение по умолчанию должно быть явно задано пользователями. Это может быть "FirstPartyIdentity", "SystemAssignedIdentity" и многое другое. | струна |
| defaultPriorityLevel | Перечисление, указывающее уровень приоритета по умолчанию для выполнения на основе приоритета. | "Высокий" "Низкий" |
| diagnosticLogSettings | Объект, представляющий различные параметры журнала диагностики для учетной записи Cosmos DB. | DiagnosticLogSettings |
| disableKeyBasedMetadataWriteAccess | Отключение операций записи с ресурсами метаданных (базами данных, контейнерами, пропускной способностью) с помощью ключей учетной записи | bool |
| disableLocalAuth | Отказ от локальной проверки подлинности и обеспечение использования только MSI и AAD можно использовать исключительно для проверки подлинности. | bool |
| enableAnalyticalStorage | Пометка, указывающее, следует ли включить аналитику хранилища. | bool |
| enableAutomaticFailover | Включает автоматическую отработку отказа области записи в редких случаях, когда регион недоступен из-за сбоя. Автоматическая отработка отказа приведет к новому региону записи для учетной записи и выбирается на основе приоритетов отработки отказа, настроенных для учетной записи. | bool |
| enableBurstCapacity | Флаг, указывающий включение и отключение функции предварительной версии емкости для учетной записи | bool |
| enableCassandraConnector | Включает соединитель cassandra в учетной записи Cosmos DB C* | bool |
| enableFreeTier | Пометка, чтобы указать, включен ли уровень "Бесплатный". | bool |
| enableMaterializedViews | Флаг, указывающий, следует ли включить MaterializedViews в учетной записи Cosmos DB | bool |
| enableMultipleWriteLocations | Позволяет учетной записи записывать в нескольких расположениях | bool |
| enablePartitionMerge | Флаг, указывающий включение и отключение функции слияния секций в учетной записи | bool |
| enablePerRegionPerPartitionAutoscale | Флаг, указывающий включение и отключение Per-Region функции автомасштабирования для секции в учетной записи | bool |
| enablePriorityBasedExecution | Флаг, указывающий включение и отключение функции предварительной версии выполнения на основе приоритета в учетной записи | bool |
| ipRules | Список IpRules. | IpAddressOrRange[] |
| isVirtualNetworkFilterEnabled | Пометка, чтобы указать, следует ли включить или отключить правила ACL виртуальной сети. | bool |
| keyVaultKeyUri | Универсальный код ресурса (URI) хранилища ключей | струна |
| Местонахождения | Массив, содержащий расположения георепликации, включенные для учетной записи Cosmos DB. | расположение[] (обязательно) |
| minTlsVersion | Указывает минимальную разрешенную версию TLS. По умолчанию используется tls 1.0, за исключением Cassandra и API Mongo, которые работают только с TLS 1.2. | Tls Tls11 Tls12 |
| networkAclBypass | Указывает, какие службы разрешены для обхода проверок брандмауэра. | AzureServices "Нет" |
| networkAclBypassResourceIds | Массив, содержащий идентификаторы ресурсов для обхода сетевого списка для учетной записи Cosmos DB. | string[] |
| publicNetworkAccess | Разрешены ли запросы из общедоступной сети | "Отключено" "Включено" 'SecuredByPerimeter' |
| restoreParameters | Параметры для указания сведений о восстановлении. | RestoreParameters |
| virtualNetworkRules | Список правил ACL виртуальной сети, настроенных для учетной записи Cosmos DB. | VirtualNetworkRule[] |
DatabaseRestoreResource
| Имя | Описание | Ценность |
|---|---|---|
| collectionNames | Имена коллекций, доступных для восстановления. | string[] |
| databaseName | Имя базы данных, доступной для восстановления. | струна |
DiagnosticLogSettings
| Имя | Описание | Ценность |
|---|---|---|
| enableFullTextQuery | Описать уровень детализации, с помощью которой необходимо регистрировать запросы. | "False" "Нет" "True" |
GremlinDatabaseRestoreResource
| Имя | Описание | Ценность |
|---|---|---|
| databaseName | Имя базы данных gremlin, доступной для восстановления. | струна |
| GraphNames | Имена графов, доступных для восстановления. | string[] |
IpAddressOrRange
| Имя | Описание | Ценность |
|---|---|---|
| ipAddressOrRange | Один IPv4-адрес или один диапазон адресов IPv4 в формате CIDR. Предоставленные IP-адреса должны быть хорошо форматированы и не могут содержаться в одном из следующих диапазонов: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, так как они не применяются фильтром IP-адресов. Пример допустимых входных данных: "23.40.210.245" или "23.40.210.0/8". | струна |
Местоположение
| Имя | Описание | Ценность |
|---|---|---|
| failoverPriority | Приоритет отработки отказа региона. Приоритет отработки отказа 0 указывает регион записи. Максимальное значение для приоритета отработки отказа = (общее число регионов - 1). Значения приоритета отработки отказа должны быть уникальными для каждого региона, в котором существует учетная запись базы данных. | int Ограничения целостности: Минимальное значение = 0 |
| isZoneRedundant | Флаг, указывающий, является ли этот регион регионом availabilityZone | bool |
| locationName | Имя региона. | струна |
ManagedServiceIdentity
| Имя | Описание | Ценность |
|---|---|---|
| тип | Тип удостоверения, используемого для ресурса. Тип SystemAssigned,UserAssigned включает как неявное созданное удостоверение, так и набор назначенных пользователем удостоверений. Тип "Нет" удаляет все удостоверения из службы. | "Нет" SystemAssigned SystemAssigned, UserAssigned UserAssigned |
| userAssignedIdentities | Список удостоверений пользователей, связанных с ресурсом. Ссылки на ключ словаря удостоверений пользователя будут идентификаторами ресурсов ARM в форме: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". | ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
| Имя | Описание | Ценность |
|---|
Microsoft.DocumentDB/databaseAccounts
| Имя | Описание | Ценность |
|---|---|---|
| apiVersion | Версия API | '2024-12-01-preview' |
| тождество | Удостоверение ресурса. | ManagedServiceIdentity |
| добрый | Указывает тип учетной записи базы данных. Это можно задать только при создании учетной записи базы данных. | GlobalDocumentDB MongoDB Синтаксический анализ |
| местоположение | Расположение группы ресурсов, к которой принадлежит ресурс. | струна |
| имя | Имя ресурса | струна Ограничения целостности: Минимальная длина = 3 Максимальная длина = 3 Pattern = ^[a-z0-9]+(-[a-z0-9]+)* (обязательно) |
| свойства | Свойства для создания и обновления учетных записей базы данных Azure Cosmos DB. | DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties (обязательно) |
| Теги | Теги ресурсов | Словарь имен и значений тегов. См. теги в шаблонах |
| тип | Тип ресурса | "Microsoft.DocumentDB/databaseAccounts" |
PeriodicModeBackupPolicy
| Имя | Описание | Ценность |
|---|---|---|
| periodicModeProperties | Значения конфигурации для периодического резервного копирования в режиме | PeriodicModeProperties |
| тип | Описывает режим резервных копий. | "Периодический" (обязательный) |
PeriodicModeProperties
| Имя | Описание | Ценность |
|---|---|---|
| backupIntervalInMinutes | Целое число, представляющее интервал в минутах между двумя резервными копиями | int Ограничения целостности: Минимальное значение = 0 |
| backupRetentionIntervalInHours | Целое число, представляющее время (в часах), которое сохраняется каждой резервной копии. | int Ограничения целостности: Минимальное значение = 0 |
| backupStorageRedundancy | Перечисление, указывающее тип расположения резервного копирования | "Гео" "Local" Зона |
RestoreParameters
| Имя | Описание | Ценность |
|---|---|---|
| databaseToRestore | Список определенных баз данных, доступных для восстановления. | DatabaseRestoreResource[] |
| gremlinDatabasesToRestore | Список конкретных баз данных gremlin, доступных для восстановления. | GremlinDatabaseRestoreResource[] |
| restoreMode | Описывает режим восстановления. | PointInTime |
| restoreSource | Идентификатор учетной записи базы данных, из которой необходимо инициировать восстановление. Например: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/location/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} | струна |
| restoreTimestampInUtc | Время восстановления учетной записи (формат ISO-8601). | струна |
| restoreWithTtlDisabled | Указывает, будет ли восстановленная учетная запись иметь время-To-Live отключена при успешном восстановлении. | bool |
| sourceBackupLocation | Исходное расположение резервного копирования для восстановления. | струна |
| tablesToRestore | Список определенных таблиц, доступных для восстановления. | string[] |
Теги
| Имя | Описание | Ценность |
|---|
VirtualNetworkRule
| Имя | Описание | Ценность |
|---|---|---|
| идентификатор | Идентификатор ресурса подсети, например /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. | струна |
| ignoreMissingVNetServiceEndpoint | Создайте правило брандмауэра до включения конечной точки службы виртуальной сети. | bool |
Шаблоны быстрого запуска
Следующие шаблоны быстрого запуска развертывают этот тип ресурса.
| Шаблон | Описание |
|---|---|
|
API SQL учетной записи Azure Cosmos DB с аналитическим хранилищем развертывание  |
Этот шаблон создает учетную запись Azure Cosmos для API Core (SQL) с базой данных и контейнером, настроенным с помощью аналитического хранилища. |
|
учетная запись Azure Cosmos DB с веб-приложением развертывание |
Этот шаблон развертывает учетную запись Azure Cosmos DB, план службы приложений и создает веб-приложение в плане службы приложений. Он также добавляет два параметра приложения в веб-приложение, ссылающееся на конечную точку учетной записи Azure Cosmos DB. Таким образом решения, развернутые в веб-приложении, могут подключаться к конечной точке учетной записи Azure Cosmos DB с помощью этих параметров. |
|
CI/CD с помощью Jenkins в службе контейнеров Azure (AKS) развертывание |
Контейнеры упрощают непрерывное создание и развертывание приложений. Оркестрируя развертывание этих контейнеров с помощью Kubernetes в службе контейнеров Azure, вы можете добиться реплицируемых управляемых кластеров контейнеров. Настроив непрерывную сборку для создания образов контейнеров и оркестрации, вы можете повысить скорость и надежность развертывания. |
|
Создание учетной записи Cosmos DB с поддержкой Microsoft Defender развертывание |
С помощью этого шаблона ARM можно развернуть учетную запись Azure Cosmos DB с включенной поддержкой Microsoft Defender для Azure Cosmos DB. Microsoft Defender для Azure Cosmos DB — это собственный уровень безопасности Azure, который обнаруживает попытки эксплойтировать базы данных в учетных записях Azure Cosmos DB. Microsoft Defender для Azure Cosmos DB обнаруживает потенциальные внедрения SQL, известные плохие субъекты на основе Microsoft Threat Intelligence, подозрительных шаблонов доступа и потенциальных эксплуатации базы данных с помощью скомпрометированных удостоверений или вредоносных участников программы предварительной оценки. |
|
Создание учетной записи Azure Cosmos DB уровня "Бесплатный" развертывание |
Этот шаблон создает бесплатную учетную запись Azure Cosmos DB для API SQL с базой данных с общей пропускной способностью и контейнером. |
|
Создание минимальной учетной записи Azure Cosmos DB для API Core (SQL) развертывание |
Этот шаблон создает учетную запись Azure Cosmos DB для API Core (SQL), указывая только минимальные обязательные свойства ресурса. |
|
Создание бессерверной учетной записи Azure Cosmos DB для API SQL развертывание |
Этот шаблон создает бессерверную учетную запись Azure Cosmos DB для API Core (SQL). |
|
создание учетной записи Azure Cosmos и веб-приложения Azure развертывание |
Этот шаблон создает учетную запись Azure Cosmos, внедряет конечную точку и ключи Cosmos DB в параметры веб-приложения Azure, а затем развертывает веб-приложение ASP MVC из GitHub. |
|
создание учетной записи Azure Cosmos для API MongoDB развертывание |
Этот шаблон создает учетную запись Azure Cosmos DB для API MongoDB 4.2 в двух регионах с использованием общей и выделенной пропускной способности с двумя коллекциями. |
|
создание учетной записи Azure Cosmos для автомасштабирования API MongoDB развертывание |
Этот шаблон создает учетную запись Azure Cosmos DB для API MongoDB 4.2 в двух регионах, используя общую и выделенную пропускную способность автомасштабирования. |
|
создание учетной записи Azure Cosmos для API таблиц развертывание |
Этот шаблон создает учетную запись Azure Cosmos DB для API таблиц в двух регионах и одну таблицу с подготовленной пропускной способностью. |
|
Создание учетной записи Azure Cosmos для API таблиц с автомасштабированием развертывание |
Этот шаблон создает учетную запись Azure Cosmos DB для API таблиц в двух регионах и одну таблицу с пропускной способностью автомасштабирования. |
|
создание учетной записи Azure Cosmos DB для API Cassandra развертывание |
Этот шаблон создает учетную запись Azure Cosmos DB для API Cassandra в двух регионах с пространством ключей и таблицей с выделенной пропускной способностью. |
|
создание учетной записи Azure Cosmos DB для API Core (SQL) развертывание |
Этот шаблон создает учетную запись Azure Cosmos для API Core (SQL) с базой данных и контейнером с пропускной способностью с несколькими другими параметрами. |
|
Создание учетной записи Azure Cosmos DB для API Gremlin развертывание |
Этот шаблон создает учетную запись Azure Cosmos DB для API Gremlin в двух регионах с одной базой данных и одним графом с выделенной пропускной способностью. |
|
Создание учетной записи Azure Cosmos DB для автомасштабирования API Gremlin развертывание |
Этот шаблон создает учетную запись Azure Cosmos DB для API Gremlin в двух регионах с одной базой данных и одним графом с помощью пропускной способности автомасштабирования. |
|
Создание учетной записи Azure Cosmos DB в нескольких регионах развертывание |
Этот шаблон создает учетную запись Azure Cosmos DB для любого типа API базы данных с основным и вторичным регионом с выбором уровня согласованности и типа отработки отказа. |
|
создание API SQL учетной записи Azure Cosmos DB с автомасштабированием развертывание |
Этот шаблон создает учетную запись Azure Cosmos для API Core (SQL) с базой данных и контейнером с пропускной способностью автомасштабирования с несколькими другими параметрами. |
|
Создание учетной записи Azure Cosmos DB с частной конечной точкой развертывание |
Этот шаблон создаст учетную запись Cosmos, виртуальную сеть и частную конечную точку, предоставляющую учетную запись Cosmos виртуальной сети. |
|
создание учетной записи SQL Azure Cosmos DB с уровня данных развертывание |
Этот шаблон создаст учетную запись SQL Cosmos, собственное определение роли и собственное назначение ролей для удостоверения AAD. |
|
создание учетной записи Azure CosmosDB развертывание |
Этот шаблон ARM предназначен для быстрого создания учетной записи CosmosDB с минимальными необходимыми значениями. |
|
Создание учетной записи azure Cosmos DB автомасштабирования для API Cassandra развертывание |
Этот шаблон создает учетную запись Azure Cosmos DB для API Cassandra в двух регионах с пространством ключей и таблицей с пропускной способностью автомасштабирования. |
|
Создание хранимых процедур API Azure Cosmos DB Core (SQL) развертывание |
Этот шаблон создает учетную запись Azure Cosmos DB для API Core (SQL) и контейнер с хранимой процедурой, триггером и определяемой пользователем функцией. |
|
Создание Azure Cosmos с помощью API SQL и нескольких контейнеров развертывание |
Шаблон создает контейнер Cosmos с API SQL и позволяет добавлять контейнеры многолитных элементов. |
|
создает приложение микрослужб Dapr с помощью приложений контейнеров развертывание |
Создайте приложение микрослужб Dapr с помощью контейнерных приложений. |
|
Создает приложение dapr pub-sub servicebus с помощью приложений контейнеров развертывание |
Создайте приложение dapr pub-sub servicebus с помощью контейнерных приложений. |
|
Развертывание базы данных Azure Data Explorer с помощью подключения Cosmos DB развертывание |
Разверните базу данных Azure Data Explorer с подключением Cosmos DB. |
|
веб-приложение с базой данных SQL, Azure Cosmos DB, поиском Azure развертывание |
Этот шаблон подготавливает веб-приложение, базу данных SQL, Azure Cosmos DB, поиск Azure и Application Insights. |
Определение ресурса Terraform (поставщик AzAPI)
Тип ресурса databaseAccounts можно развернуть с помощью операций, предназначенных для следующих операций:
- групп ресурсов
Список измененных свойств в каждой версии API см. в журнала изменений.
Формат ресурса
Чтобы создать ресурс Microsoft.DocumentDB/databaseAccounts, добавьте следующий объект Terraform в шаблон.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/databaseAccounts@2024-12-01-preview"
name = "string"
identity = {
type = "string"
userAssignedIdentities = {
{customized property} = {
}
}
}
kind = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = jsonencode({
properties = {
analyticalStorageConfiguration = {
schemaType = "string"
}
apiProperties = {
serverVersion = "string"
}
backupPolicy = {
migrationState = {
startTime = "string"
status = "string"
targetType = "string"
}
type = "string"
// For remaining properties, see BackupPolicy objects
}
capabilities = [
{
name = "string"
}
]
capacity = {
totalThroughputLimit = int
}
capacityMode = "string"
connectorOffer = "string"
consistencyPolicy = {
defaultConsistencyLevel = "string"
maxIntervalInSeconds = int
maxStalenessPrefix = int
}
cors = [
{
allowedHeaders = "string"
allowedMethods = "string"
allowedOrigins = "string"
exposedHeaders = "string"
maxAgeInSeconds = int
}
]
createMode = "string"
customerManagedKeyStatus = "string"
databaseAccountOfferType = "Standard"
defaultIdentity = "string"
defaultPriorityLevel = "string"
diagnosticLogSettings = {
enableFullTextQuery = "string"
}
disableKeyBasedMetadataWriteAccess = bool
disableLocalAuth = bool
enableAnalyticalStorage = bool
enableAutomaticFailover = bool
enableBurstCapacity = bool
enableCassandraConnector = bool
enableFreeTier = bool
enableMaterializedViews = bool
enableMultipleWriteLocations = bool
enablePartitionMerge = bool
enablePerRegionPerPartitionAutoscale = bool
enablePriorityBasedExecution = bool
ipRules = [
{
ipAddressOrRange = "string"
}
]
isVirtualNetworkFilterEnabled = bool
keyVaultKeyUri = "string"
locations = [
{
failoverPriority = int
isZoneRedundant = bool
locationName = "string"
}
]
minimalTlsVersion = "string"
networkAclBypass = "string"
networkAclBypassResourceIds = [
"string"
]
publicNetworkAccess = "string"
restoreParameters = {
databasesToRestore = [
{
collectionNames = [
"string"
]
databaseName = "string"
}
]
gremlinDatabasesToRestore = [
{
databaseName = "string"
graphNames = [
"string"
]
}
]
restoreMode = "string"
restoreSource = "string"
restoreTimestampInUtc = "string"
restoreWithTtlDisabled = bool
sourceBackupLocation = "string"
tablesToRestore = [
"string"
]
}
virtualNetworkRules = [
{
id = "string"
ignoreMissingVNetServiceEndpoint = bool
}
]
}
})
}
Объекты BackupPolicy
Задайте свойство типа
Для непрерывнойиспользуйте:
{
continuousModeProperties = {
tier = "string"
}
type = "Continuous"
}
Для периодического
{
periodicModeProperties = {
backupIntervalInMinutes = int
backupRetentionIntervalInHours = int
backupStorageRedundancy = "string"
}
type = "Periodic"
}
Значения свойств
AnalyticStorageConfiguration
| Имя | Описание | Ценность |
|---|---|---|
| schemaType | Описывает типы схемы для аналитического хранилища. | "FullFidelity" 'WellDefined' |
ApiProperties
| Имя | Описание | Ценность |
|---|---|---|
| serverVersion | Описывает версию учетной записи MongoDB. | '3.2' '3.6' '4.0' '4.2' '5.0' '6.0' '7.0' |
BackupPolicy
| Имя | Описание | Ценность |
|---|---|---|
| migrationState | Объект, представляющий состояние миграции между политиками резервного копирования. | BackupPolicyMigrationState |
| тип | Задайте значение "Непрерывный" для типа ContinuousModeBackupPolicy. Задайте значение "Периодический" для типа PeriodicModeBackupPolicy. | "Непрерывный" "Периодический" (обязательный) |
BackupPolicyMigrationState
| Имя | Описание | Ценность |
|---|---|---|
| startTime | Время начала миграции политики резервного копирования (формат ISO-8601). | струна |
| статус | Описывает состояние миграции между типами политик резервного копирования. | "Завершено" "Не удалось" 'InProgress' "Недопустимый" |
| targetType | Описывает тип целевой политики резервного копирования миграции политики резервного копирования. | "Непрерывный" "Периодический" |
Способность
| Имя | Описание | Ценность |
|---|---|---|
| имя | Имя возможности Cosmos DB. Например, "name": "EnableCassandra". Текущие значения также включают EnableTable и EnableGremlin. | струна |
Способность
| Имя | Описание | Ценность |
|---|---|---|
| totalThroughputLimit | Общее ограничение пропускной способности, установленное для учетной записи. Общий объем пропускной способности 2000 года в 2000 году накладывает строгий предел максимальной пропускной способности, который может быть подготовлен для этой учетной записи в 2000 году. Общий объем -1 -1 не ограничивает подготовку пропускной способности. | int Ограничения целостности: Минимальное значение = -1 |
Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties
| Имя | Описание | Ценность |
|---|
ConsistencyPolicy
| Имя | Описание | Ценность |
|---|---|---|
| defaultConsistencyLevel | Уровень согласованности по умолчанию и параметры конфигурации учетной записи Cosmos DB. | 'BoundedStaleness' "ConsistentPrefix" "В конечном итоге" "Сеанс" "Strong" (обязательно) |
| maxIntervalInSeconds | При использовании с уровнем согласованности с ограниченной устаревшей степенью согласованности это значение представляет допустимое время устаревания (в секундах). Допустимый диапазон для этого значения составляет 5 – 86400. Требуется, если для defaultConsistencyPolicy задано значение BoundedStaleness. | int Ограничения целостности: Минимальное значение = 5 Максимальное значение = 86400 |
| maxStalenessPrefix | При использовании с уровнем согласованности с ограниченной устаревшим состоянием это значение представляет количество устаревших запросов, допустимых. Допустимый диапазон для этого значения составляет 1 – 2 147 483 647. Требуется, если для defaultConsistencyPolicy задано значение BoundedStaleness. | int Ограничения целостности: Минимальное значение = 1 Максимальное значение = 2147483647 |
ContinuousModeBackupPolicy
| Имя | Описание | Ценность |
|---|---|---|
| continuousModeProperties | Значения конфигурации для резервного копирования в непрерывном режиме | ContinuousModeProperties |
| тип | Описывает режим резервных копий. | "Непрерывный" (обязательный) |
ContinuousModeProperties
| Имя | Описание | Ценность |
|---|---|---|
| ярус | Перечисление для указания типа режима резервного копирования Continuos | 'Continuous30Days' 'Continuous7Days' |
CorsPolicy
| Имя | Описание | Ценность |
|---|---|---|
| allowedHeaders | Заголовки запроса, указанные в исходном домене, могут указываться в запросе CORS. | струна |
| allowedMethods | Методы (команды HTTP-запроса), которые домен-источник может использовать для запроса CORS. | струна |
| allowedOrigins | Домены источника, которые разрешены запрашивать службу через CORS. | строка (обязательно) |
| exposedHeaders | Заголовки ответа, которые могут быть отправлены в ответ на запрос CORS и предоставляются браузером издателю запроса. | струна |
| maxAgeInSeconds | Максимальное время, которое браузер должен кэшировать запрос preflight OPTIONS. | int Ограничения целостности: Минимальное значение = 1 Максимальное значение = 2147483647 |
DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties
| Имя | Описание | Ценность |
|---|---|---|
| analyticStorageConfiguration | Конкретные свойства аналитического хранилища. | AnalyticStorageConfiguration |
| apiProperties | Определенные свойства API. В настоящее время поддерживается только для API MongoDB. | ApiProperties |
| backupPolicy | Объект, представляющий политику для создания резервных копий в учетной записи. | BackupPolicy |
| Возможности | Список возможностей Cosmos DB для учетной записи | возможности[] |
| способность | Объект, представляющий все свойства, связанные с применением емкости в учетной записи. | емкости |
| capacityMode | Указывает емкостьmode учетной записи Cosmos DB. | "Нет" "Подготовлено" "Бессерверный" |
| connectorOffer | Тип предложения соединителя cassandra для учетной записи базы данных Cosmos DB C*. | "Маленький" |
| consistencyPolicy | Политика согласованности для учетной записи Cosmos DB. | ConsistencyPolicy |
| cors | Политика CORS для учетной записи базы данных Cosmos DB. | CorsPolicy[] |
| createMode | Перечисление, указывающее режим создания учетной записи. | По умолчанию "Восстановить" |
| customerManagedKeyStatus | Указывает состояние функции управляемого клиентом ключа в учетной записи. В случае возникновения ошибок свойство предоставляет рекомендации по устранению неполадок. | струна |
| databaseAccountOfferType | Тип предложения для базы данных | "Стандартный" (обязательный) |
| defaultIdentity | Удостоверение по умолчанию для доступа к хранилищу ключей, используемого в таких функциях, как управляемые клиентом ключи. Удостоверение по умолчанию должно быть явно задано пользователями. Это может быть "FirstPartyIdentity", "SystemAssignedIdentity" и многое другое. | струна |
| defaultPriorityLevel | Перечисление, указывающее уровень приоритета по умолчанию для выполнения на основе приоритета. | "Высокий" "Низкий" |
| diagnosticLogSettings | Объект, представляющий различные параметры журнала диагностики для учетной записи Cosmos DB. | DiagnosticLogSettings |
| disableKeyBasedMetadataWriteAccess | Отключение операций записи с ресурсами метаданных (базами данных, контейнерами, пропускной способностью) с помощью ключей учетной записи | bool |
| disableLocalAuth | Отказ от локальной проверки подлинности и обеспечение использования только MSI и AAD можно использовать исключительно для проверки подлинности. | bool |
| enableAnalyticalStorage | Пометка, указывающее, следует ли включить аналитику хранилища. | bool |
| enableAutomaticFailover | Включает автоматическую отработку отказа области записи в редких случаях, когда регион недоступен из-за сбоя. Автоматическая отработка отказа приведет к новому региону записи для учетной записи и выбирается на основе приоритетов отработки отказа, настроенных для учетной записи. | bool |
| enableBurstCapacity | Флаг, указывающий включение и отключение функции предварительной версии емкости для учетной записи | bool |
| enableCassandraConnector | Включает соединитель cassandra в учетной записи Cosmos DB C* | bool |
| enableFreeTier | Пометка, чтобы указать, включен ли уровень "Бесплатный". | bool |
| enableMaterializedViews | Флаг, указывающий, следует ли включить MaterializedViews в учетной записи Cosmos DB | bool |
| enableMultipleWriteLocations | Позволяет учетной записи записывать в нескольких расположениях | bool |
| enablePartitionMerge | Флаг, указывающий включение и отключение функции слияния секций в учетной записи | bool |
| enablePerRegionPerPartitionAutoscale | Флаг, указывающий включение и отключение Per-Region функции автомасштабирования для секции в учетной записи | bool |
| enablePriorityBasedExecution | Флаг, указывающий включение и отключение функции предварительной версии выполнения на основе приоритета в учетной записи | bool |
| ipRules | Список IpRules. | IpAddressOrRange[] |
| isVirtualNetworkFilterEnabled | Пометка, чтобы указать, следует ли включить или отключить правила ACL виртуальной сети. | bool |
| keyVaultKeyUri | Универсальный код ресурса (URI) хранилища ключей | струна |
| Местонахождения | Массив, содержащий расположения георепликации, включенные для учетной записи Cosmos DB. | расположение[] (обязательно) |
| minTlsVersion | Указывает минимальную разрешенную версию TLS. По умолчанию используется tls 1.0, за исключением Cassandra и API Mongo, которые работают только с TLS 1.2. | Tls Tls11 Tls12 |
| networkAclBypass | Указывает, какие службы разрешены для обхода проверок брандмауэра. | AzureServices "Нет" |
| networkAclBypassResourceIds | Массив, содержащий идентификаторы ресурсов для обхода сетевого списка для учетной записи Cosmos DB. | string[] |
| publicNetworkAccess | Разрешены ли запросы из общедоступной сети | "Отключено" "Включено" 'SecuredByPerimeter' |
| restoreParameters | Параметры для указания сведений о восстановлении. | RestoreParameters |
| virtualNetworkRules | Список правил ACL виртуальной сети, настроенных для учетной записи Cosmos DB. | VirtualNetworkRule[] |
DatabaseRestoreResource
| Имя | Описание | Ценность |
|---|---|---|
| collectionNames | Имена коллекций, доступных для восстановления. | string[] |
| databaseName | Имя базы данных, доступной для восстановления. | струна |
DiagnosticLogSettings
| Имя | Описание | Ценность |
|---|---|---|
| enableFullTextQuery | Описать уровень детализации, с помощью которой необходимо регистрировать запросы. | "False" "Нет" "True" |
GremlinDatabaseRestoreResource
| Имя | Описание | Ценность |
|---|---|---|
| databaseName | Имя базы данных gremlin, доступной для восстановления. | струна |
| GraphNames | Имена графов, доступных для восстановления. | string[] |
IpAddressOrRange
| Имя | Описание | Ценность |
|---|---|---|
| ipAddressOrRange | Один IPv4-адрес или один диапазон адресов IPv4 в формате CIDR. Предоставленные IP-адреса должны быть хорошо форматированы и не могут содержаться в одном из следующих диапазонов: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, так как они не применяются фильтром IP-адресов. Пример допустимых входных данных: "23.40.210.245" или "23.40.210.0/8". | струна |
Местоположение
| Имя | Описание | Ценность |
|---|---|---|
| failoverPriority | Приоритет отработки отказа региона. Приоритет отработки отказа 0 указывает регион записи. Максимальное значение для приоритета отработки отказа = (общее число регионов - 1). Значения приоритета отработки отказа должны быть уникальными для каждого региона, в котором существует учетная запись базы данных. | int Ограничения целостности: Минимальное значение = 0 |
| isZoneRedundant | Флаг, указывающий, является ли этот регион регионом availabilityZone | bool |
| locationName | Имя региона. | струна |
ManagedServiceIdentity
| Имя | Описание | Ценность |
|---|---|---|
| тип | Тип удостоверения, используемого для ресурса. Тип SystemAssigned,UserAssigned включает как неявное созданное удостоверение, так и набор назначенных пользователем удостоверений. Тип "Нет" удаляет все удостоверения из службы. | "Нет" SystemAssigned SystemAssigned, UserAssigned UserAssigned |
| userAssignedIdentities | Список удостоверений пользователей, связанных с ресурсом. Ссылки на ключ словаря удостоверений пользователя будут идентификаторами ресурсов ARM в форме: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". | ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
| Имя | Описание | Ценность |
|---|
Microsoft.DocumentDB/databaseAccounts
| Имя | Описание | Ценность |
|---|---|---|
| тождество | Удостоверение ресурса. | ManagedServiceIdentity |
| добрый | Указывает тип учетной записи базы данных. Это можно задать только при создании учетной записи базы данных. | GlobalDocumentDB MongoDB Синтаксический анализ |
| местоположение | Расположение группы ресурсов, к которой принадлежит ресурс. | струна |
| имя | Имя ресурса | струна Ограничения целостности: Минимальная длина = 3 Максимальная длина = 3 Pattern = ^[a-z0-9]+(-[a-z0-9]+)* (обязательно) |
| свойства | Свойства для создания и обновления учетных записей базы данных Azure Cosmos DB. | DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties (обязательно) |
| Теги | Теги ресурсов | Словарь имен и значений тегов. |
| тип | Тип ресурса | "Microsoft.DocumentDB/databaseAccounts@2024-12-01-preview" |
PeriodicModeBackupPolicy
| Имя | Описание | Ценность |
|---|---|---|
| periodicModeProperties | Значения конфигурации для периодического резервного копирования в режиме | PeriodicModeProperties |
| тип | Описывает режим резервных копий. | "Периодический" (обязательный) |
PeriodicModeProperties
| Имя | Описание | Ценность |
|---|---|---|
| backupIntervalInMinutes | Целое число, представляющее интервал в минутах между двумя резервными копиями | int Ограничения целостности: Минимальное значение = 0 |
| backupRetentionIntervalInHours | Целое число, представляющее время (в часах), которое сохраняется каждой резервной копии. | int Ограничения целостности: Минимальное значение = 0 |
| backupStorageRedundancy | Перечисление, указывающее тип расположения резервного копирования | "Гео" "Local" Зона |
RestoreParameters
| Имя | Описание | Ценность |
|---|---|---|
| databaseToRestore | Список определенных баз данных, доступных для восстановления. | DatabaseRestoreResource[] |
| gremlinDatabasesToRestore | Список конкретных баз данных gremlin, доступных для восстановления. | GremlinDatabaseRestoreResource[] |
| restoreMode | Описывает режим восстановления. | PointInTime |
| restoreSource | Идентификатор учетной записи базы данных, из которой необходимо инициировать восстановление. Например: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/location/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} | струна |
| restoreTimestampInUtc | Время восстановления учетной записи (формат ISO-8601). | струна |
| restoreWithTtlDisabled | Указывает, будет ли восстановленная учетная запись иметь время-To-Live отключена при успешном восстановлении. | bool |
| sourceBackupLocation | Исходное расположение резервного копирования для восстановления. | струна |
| tablesToRestore | Список определенных таблиц, доступных для восстановления. | string[] |
Теги
| Имя | Описание | Ценность |
|---|
VirtualNetworkRule
| Имя | Описание | Ценность |
|---|---|---|
| идентификатор | Идентификатор ресурса подсети, например /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. | струна |
| ignoreMissingVNetServiceEndpoint | Создайте правило брандмауэра до включения конечной точки службы виртуальной сети. | bool |