База данных Microsoft.DocumentDBУчетные записи 2022-08-15
- Актуальная
- 2024-05-15
- 15.05.2024 г.
- 15.02.2024 г.
- 2023-11-15
- 15.11.2023 г.
- 2023-09-15
- 15.09.2023 г.
- 2023-04-15
- 2023-03-15
- 15.03.2023 г.
- 2023-03-01-preview
- 2022-11-15
- 15.11.2022 г.
- 2022-08-15
- 2022-08-15-preview
- 2022-05-15
- 2022-05-15-preview
- 15.02.2022 г.
- 15.11.2021-preview
- 2021-10-15
- 15.10.2021 г.
- 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
- 01.08.2019
- 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@2022-08-15' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
kind: 'string'
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
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
}
connectorOffer: 'Small'
consistencyPolicy: {
defaultConsistencyLevel: 'string'
maxIntervalInSeconds: int
maxStalenessPrefix: int
}
cors: [
{
allowedHeaders: 'string'
allowedMethods: 'string'
allowedOrigins: 'string'
exposedHeaders: 'string'
maxAgeInSeconds: int
}
]
createMode: 'string'
databaseAccountOfferType: 'Standard'
defaultIdentity: 'string'
disableKeyBasedMetadataWriteAccess: bool
disableLocalAuth: bool
enableAnalyticalStorage: bool
enableAutomaticFailover: bool
enableCassandraConnector: bool
enableFreeTier: bool
enableMultipleWriteLocations: bool
enablePartitionMerge: bool
ipRules: [
{
ipAddressOrRange: 'string'
}
]
isVirtualNetworkFilterEnabled: bool
keyVaultKeyUri: 'string'
locations: [
{
failoverPriority: int
isZoneRedundant: bool
locationName: 'string'
}
]
networkAclBypass: 'string'
networkAclBypassResourceIds: [
'string'
]
publicNetworkAccess: 'string'
restoreParameters: {
databasesToRestore: [
{
collectionNames: [
'string'
]
databaseName: 'string'
}
]
restoreMode: 'PointInTime'
restoreSource: 'string'
restoreTimestampInUtc: 'string'
}
virtualNetworkRules: [
{
id: 'string'
ignoreMissingVNetServiceEndpoint: bool
}
]
}
}
Объекты BackupPolicy
Задайте свойство type , чтобы указать тип объекта .
Для непрерывного использования используйте:
type: 'Continuous'
В параметре Periodic используйте:
type: 'Periodic'
periodicModeProperties: {
backupIntervalInMinutes: int
backupRetentionIntervalInHours: int
backupStorageRedundancy: 'string'
}
Значения свойств
databaseAccounts
| Имя | Описание | Значение |
|---|---|---|
| name | имя ресурса. | строка (обязательно) Ограничение символов: 3–44 Допустимые символы: Строчные буквы, цифры и дефисы. Начинается со строчной буквы или цифры. Имя ресурса должно быть уникальным в Azure. |
| location | Расположение группы ресурсов, к которой принадлежит ресурс. | строка |
| tags | Теги — это список пар "ключ-значение", описывающих ресурс. Эти теги можно использовать при просмотре и группировании ресурсов (между группами). Для ресурса можно указать не более 15 тегов. В каждом теге длина ключа нее должна превышать 128 символов, а длина значения — 256 символов. Например, для типа шаблона по умолчанию задано значение defaultExperience: Cassandra. Текущие значения defaultExperience также включают "Table", "Graph", "DocumentDB" и "MongoDB". | Словарь имен и значений тегов. См . раздел Теги в шаблонах |
| kind | Указывает тип учетной записи базы данных. Это можно задать только при создании учетной записи базы данных. | GlobalDocumentDB MongoDB "Синтаксический анализ" |
| удостоверение | Удостоверение ресурса. | Управляемое удостоверение службы |
| properties | Свойства для создания и обновления учетных записей базы данных Azure Cosmos DB. | DatabaseAccountCreateUpdatePropertiesOrDatabaseAccou... (обязательно) |
Управляемое удостоверение службы
| Имя | Описание | Значение |
|---|---|---|
| тип | Тип удостоверения, используемого для ресурса. Тип SystemAssigned,UserAssigned включает как неявно созданное удостоверение, так и набор удостоверений, назначаемых пользователем. Тип None удалит все удостоверения из службы. | "Нет" SystemAssigned "SystemAssigned,UserAssigned" UserAssigned |
| userAssignedIdentities | Список удостоверений пользователей, связанных с ресурсом. Ссылки на ключ словаря удостоверений пользователей будут иметь идентификаторы ресурсов ARM в формате "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". | ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
| Имя | Описание | Значение |
|---|---|---|
| {настроенное свойство} | Components1Jq1T4ISchemasManagedserviceidentityProper... |
Components1Jq1T4ISchemasManagedserviceidentityProper...
Этот объект не содержит свойств, которые необходимо задать во время развертывания. Все свойства доступны только для чтения.
DatabaseAccountCreateUpdatePropertiesOrDatabaseAccou...
| Имя | Описание | Значение |
|---|---|---|
| analyticStorageConfiguration | Свойства аналитического хранилища. | AnalyticStorageConfiguration |
| apiProperties | Свойства API. В настоящее время поддерживается только для API MongoDB. | ApiProperties |
| backupPolicy | Объект , представляющий политику для создания резервных копий в учетной записи. | BackupPolicy |
| capabilities | Список возможностей Cosmos DB для учетной записи | Возможность[] |
| Емкость | Объект , представляющий все свойства, связанные с принудительным применением емкости в учетной записи. | Производительность |
| connectorOffer | Тип предложения соединителя cassandra для учетной записи C* базы данных Cosmos DB. | "Маленький" |
| consistencyPolicy | Политика согласованности для учетной записи Cosmos DB. | ConsistencyPolicy |
| cors | Политика CORS для учетной записи базы данных Cosmos DB. | CorsPolicy[] |
| createMode | Перечисление для указания режима создания учетной записи. | 'Default' Восстановление |
| databaseAccountOfferType | Тип предложения для базы данных | "Стандартный" (обязательно) |
| defaultIdentity | Удостоверение по умолчанию для доступа к хранилищу ключей, используемое в таких функциях, как управляемые клиентом ключи. Удостоверение по умолчанию должно быть явно задано пользователями. Это может быть FirstPartyIdentity, SystemAssignedIdentity и многое другое. | строка |
| disableKeyBasedMetadataWriteAccess | Отключение операций записи для ресурсов метаданных (базы данных, контейнеры, пропускная способность) с помощью ключей учетной записи | bool |
| disableLocalAuth | Отказаться от локальной проверки подлинности и убедиться, что для проверки подлинности можно использовать только MSI и AAD. | bool |
| enableAnalyticalStorage | Флаг, указывающий, следует ли включить аналитику хранилища. | bool |
| enableAutomaticFailover | Включает автоматическую отработку отказа региона записи в редких случаях, когда регион становится недоступным из-за сбоя. Автоматическая отработка отказа приведет к созданию нового региона записи для учетной записи и выбирается на основе приоритетов отработки отказа, настроенных для учетной записи. | bool |
| enableCassandraConnector | Включает соединитель cassandra в учетной записи C* Cosmos DB | bool |
| enableFreeTier | Флаг, указывающий, включен ли уровень "Бесплатный". | bool |
| enableMultipleWriteLocations | Позволяет учетной записи выполнять запись в нескольких расположениях. | bool |
| enablePartitionMerge | Флаг, указывающий на включение или отключение функции слияния секций в учетной записи | bool |
| ipRules | Список IpRules. | IpAddressOrRange[] |
| isVirtualNetworkFilterEnabled | Флаг, указывающий, следует ли включать или отключать правила ACL для виртуальной сети. | bool |
| keyVaultKeyUri | Универсальный код ресурса (URI) хранилища ключей | строка |
| Расположения | Массив, содержащий расположения георепликации, включенные для учетной записи Cosmos DB. | Location[] (обязательно) |
| networkAclBypass | Указывает, каким службам разрешено обходить проверки брандмауэра. | AzureServices "Нет" |
| networkAclBypassResourceIds | Массив, содержащий идентификаторы ресурсов для обхода сетевого списка ACL для учетной записи Cosmos DB. | string[] |
| publicNetworkAccess | Разрешены ли запросы из общедоступной сети | "Отключено" "Включено" |
| restoreParameters | Параметры, указывающие сведения о восстановлении. | RestoreParameters |
| virtualNetworkRules | Список правил ACL виртуальной сети, настроенных для учетной записи Cosmos DB. | VirtualNetworkRule[] |
AnalyticStorageConfiguration
| Имя | Описание | Значение |
|---|---|---|
| schemaType | Описывает типы схемы для аналитического хранилища. | 'FullFidelity' 'WellDefined' |
ApiProperties
| Имя | Описание | Значение |
|---|---|---|
| serverVersion | Описывает ServerVersion учетной записи MongoDB. | '3.2' '3.6' '4.0' '4.2' |
BackupPolicy
| Имя | Описание | Значение |
|---|---|---|
| migrationState | Объект , представляющий состояние миграции между политиками резервного копирования. | BackupPolicyMigrationState |
| тип | Установка типа объекта | Непрерывные Периодическая (обязательно) |
BackupPolicyMigrationState
| Имя | Описание | Значение |
|---|---|---|
| startTime | Время начала миграции политики резервного копирования (формат ISO-8601). | строка |
| status | Описывает состояние миграции между типами политик резервного копирования. | "Завершено" "Сбой" 'InProgress' "Недопустимый" |
| targetType | Описывает тип целевой политики резервного копирования для миграции политики резервного копирования. | "Непрерывный" "Периодическая" |
ContinuousModeBackupPolicy
| Имя | Описание | Значение |
|---|---|---|
| тип | Описывает режим резервного копирования. | Continuous (обязательный) |
PeriodicModeBackupPolicy
| Имя | Описание | Значение |
|---|---|---|
| тип | Описывает режим резервного копирования. | "Periodic" (обязательно) |
| periodicModeProperties | Значения конфигурации для резервного копирования в периодическом режиме | PeriodicModeProperties |
PeriodicModeProperties
| Имя | Описание | Значение |
|---|---|---|
| backupIntervalInMinutes | Целое число, представляющее интервал между двумя резервными копиями в минутах. | INT Ограничения: Минимальное значение = 0 |
| backupRetentionIntervalInHours | Целое число, представляющее время (в часах) хранения каждой резервной копии. | INT Ограничения: Минимальное значение = 0 |
| backupStorageRedundancy | Перечисление для указания типа расположения резервных копий | "Географическое расположение" "Локальный" "Зона" |
Функция
| Имя | Описание | Значение |
|---|---|---|
| name | Имя возможности Cosmos DB. Например, "name": "EnableCassandra". Текущие значения также включают "EnableTable" и "EnableGremlin". | строка |
Capacity
| Имя | Описание | Значение |
|---|---|---|
| totalThroughputLimit | Общее ограничение пропускной способности, установленное для учетной записи. TotalThroughputLimit 2000 устанавливает строгое ограничение максимальной пропускной способности, которое может быть подготовлено для этой учетной записи до 2000. Значение totalThroughputLimit в -1 указывает на отсутствие ограничений на подготовку пропускной способности. | INT |
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 |
CorsPolicy
| Имя | Описание | Значение |
|---|---|---|
| allowedHeaders | Заголовки запросов, которые исходный домен может указывать в запросах CORS. | строка |
| allowedMethods | Методы (команды HTTP-запросов), которые может использовать исходный домен для выполнения запроса CORS. | строка |
| allowedOrigins | Домены источника, которым разрешено выполнять запрос к службе через CORS. | строка (обязательно) |
| exposedHeaders | Заголовки ответов, которые можете отправить в ответ на запрос CORS и предоставить отправителю запроса с помощью браузера. | строка |
| maxAgeInSeconds | Максимальная продолжительность хранения предварительных запросов OPTIONS в кэше браузера. | INT Ограничения: Минимальное значение = 1 Максимальное значение = 2147483647 |
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 | Имя области. | строка |
RestoreParameters
| Имя | Описание | Значение |
|---|---|---|
| databasesToRestore | Список конкретных баз данных, доступных для восстановления. | DatabaseRestoreResource[] |
| restoreMode | Описывает режим восстановления. | PointInTime |
| restoreSource | Идентификатор восстанавливаемой учетной записи базы данных, из которой должно быть инициировано восстановление. Например: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccounts} | строка |
| restoreTimestampInUtc | Время восстановления учетной записи (формат ISO-8601). | строка |
DatabaseRestoreResource
| Имя | Описание | Значение |
|---|---|---|
| collectionNames | Имена коллекций, доступных для восстановления. | string[] |
| databaseName | Имя базы данных, доступной для восстановления. | строка |
VirtualNetworkRule
| Имя | Описание | Значение |
|---|---|---|
| идентификатор | Идентификатор ресурса подсети, например : /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. | строка |
| ignoreMissingVNetServiceEndpoint | Создайте правило брандмауэра, прежде чем в виртуальной сети включена конечная точка службы виртуальной сети. | bool |
Шаблоны быстрого запуска
Следующие шаблоны быстрого запуска развертывают этот тип ресурса.
| Шаблон | Описание |
|---|---|
CI/CD с использованием Jenkins в Службе контейнеров Azure (AKS) |
Контейнеры упрощают непрерывную сборку и развертывание приложений. Управляя развертыванием этих контейнеров с помощью Kubernetes в Службе контейнеров Azure, вы можете создать реплицируемые управляемые кластеры контейнеров. Настроив непрерывную сборку для создания образов контейнеров и оркестрации, вы можете повысить скорость и надежность развертывания. |
| Веб-приложение с базой данных SQL, Azure Cosmos DB, поискОм Azure |
Этот шаблон подготавливает веб-приложение, базу данных SQL, Azure Cosmos DB, поиск Azure и Application Insights. |
| Создание учетной записи Azure Cosmos DB для API Cassandra |
Этот шаблон создает учетную запись Azure Cosmos DB для API Cassandra в двух регионах с пространством ключей и таблицей с выделенной пропускной способностью. |
| Создание учетной записи автомасштабирования Azure Cosmos DB для API Cassandra |
Этот шаблон создает учетную запись Azure Cosmos DB для API Cassandra в двух регионах с пространством ключей и таблицей с автомасштабируемой пропускной способностью. |
| Создание учетной записи Azure CosmosDB |
Этот шаблон ARM предназначен для быстрого создания учетной записи CosmosDB с минимальными необходимыми значениями. |
| Создание учетной записи Azure Cosmos DB в нескольких регионах |
Этот шаблон создает учетную запись Azure Cosmos DB для любого типа API базы данных с основным и вторичным регионами с выбором уровня согласованности и типа отработки отказа. |
| Создание учетной записи Azure Cosmos DB бесплатного уровня |
Этот шаблон создает учетную запись Azure Cosmos DB бесплатного уровня для API SQL с базой данных с общей пропускной способностью и контейнером. |
| Создание учетной записи Azure Cosmos DB для API Gremlin |
Этот шаблон создает учетную запись Azure Cosmos DB для API Gremlin в двух регионах с одной базой данных и одним графом с использованием выделенной пропускной способности. |
| Создание учетной записи Azure Cosmos DB для автомасштабирования API Gremlin |
Этот шаблон создает учетную запись Azure Cosmos DB для API Gremlin в двух регионах с одной базой данных и одним графом с использованием автомасштабируемой пропускной способности. |
| Создание учетной записи Azure Cosmos для API MongoDB |
Этот шаблон создает учетную запись Azure Cosmos DB для API MongoDB 4.2 в двух регионах с использованием общей и выделенной пропускной способности с двумя коллекциями. |
| Создание учетной записи Azure Cosmos для автомасштабирования API MongoDB |
Этот шаблон создает учетную запись Azure Cosmos DB для API MongoDB 4.2 в двух регионах с использованием общей и выделенной пропускной способности автомасштабирования. |
| Создание учетной записи Azure Cosmos DB с частной конечной точкой |
Этот шаблон создаст учетную запись Cosmos, виртуальную сеть и частную конечную точку, предоставляющую учетную запись Cosmos виртуальной сети. |
| Создание учетной записи Azure Cosmos DB для API Core (SQL) |
Этот шаблон создает учетную запись Azure Cosmos для API Core (SQL) с базой данных и контейнером с пропускной способностью с несколькими другими вариантами. |
| API SQL учетной записи Azure Cosmos DB с аналитическим хранилищем |
Этот шаблон создает учетную запись Azure Cosmos для API Core (SQL) с базой данных и контейнером, настроенными с аналитическим хранилищем. |
| Создание API SQL учетной записи Azure Cosmos DB с автомасштабированием |
Этот шаблон создает учетную запись Azure Cosmos для API Core (SQL) с базой данных и контейнером с автомасштабируемой пропускной способностью с несколькими другими вариантами. |
| Создание хранимых процедур API Azure Cosmos DB Core (SQL) |
Этот шаблон создает учетную запись Azure Cosmos DB для API Core (SQL) и контейнер с хранимой процедурой, триггером и определяемой пользователем функцией. |
| Создание минимальной учетной записи Azure Cosmos DB для API Core (SQL) |
Этот шаблон создает учетную запись Azure Cosmos DB для API Core (SQL) с указанием только минимальных обязательных свойств ресурса. |
| Создание Azure Cosmos с ПОМОЩЬЮ API SQL и нескольких контейнеров |
Шаблон создает контейнер Cosmos с API SQL и позволяет добавлять многообразные контейнеры. |
| Создание учетной записи SQL Azure Cosmos DB с помощью RBAC плоскости данных |
Этот шаблон создает учетную запись SQL Cosmos DB, встроенное определение роли и встроенное назначение роли для удостоверения Azure Active Directory. |
| Создание бессерверной учетной записи Azure Cosmos DB для API SQL |
Этот шаблон создает бессерверную учетную запись Azure Cosmos DB для API Core (SQL). |
| Создание учетной записи Azure Cosmos для API таблиц |
Этот шаблон создает учетную запись Azure Cosmos DB для API таблиц в двух регионах и одну таблицу с подготовленной пропускной способностью. |
| Создание учетной записи Azure Cosmos для API таблиц с автомасштабированием |
Этот шаблон создает учетную запись Azure Cosmos DB для API таблиц в двух регионах и одну таблицу с автомасштабируемой пропускной способностью. |
| Создание учетной записи Azure Cosmos и веб-приложения Azure |
Этот шаблон создает учетную запись Azure Cosmos, внедряет конечную точку и ключи Cosmos DB в параметры веб-приложения Azure, а затем развертывает веб-приложение ASP MVC из GitHub. |
| Создание учетной записи 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 Data Explorer DB с подключением к Cosmos DB |
Развертывание Azure Data Explorer DB с подключением к Cosmos DB. |
| Учетная запись Azure Cosmos DB с веб-приложением |
Этот шаблон развертывает учетную запись Azure Cosmos DB, план службы приложений и создает веб-приложение в плане службы приложений. Он также добавляет два параметра приложения в веб-приложение, которые ссылаться на конечную точку учетной записи Azure Cosmos DB. Таким образом, решения, развернутые в веб-приложении, могут подключаться к конечной точке учетной записи Azure Cosmos DB с помощью этих параметров. |
Определение ресурса шаблона ARM
Тип ресурса databaseAccounts можно развернуть с помощью операций, предназначенных для:
- Группы ресурсов — см. команды развертывания группы ресурсов.
Список измененных свойств в каждой версии API см. в журнале изменений.
Формат ресурсов
Чтобы создать ресурс Microsoft.DocumentDB/databaseAccounts, добавьте следующий код JSON в шаблон.
{
"type": "Microsoft.DocumentDB/databaseAccounts",
"apiVersion": "2022-08-15",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"kind": "string",
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {}
}
},
"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"
},
"connectorOffer": "Small",
"consistencyPolicy": {
"defaultConsistencyLevel": "string",
"maxIntervalInSeconds": "int",
"maxStalenessPrefix": "int"
},
"cors": [
{
"allowedHeaders": "string",
"allowedMethods": "string",
"allowedOrigins": "string",
"exposedHeaders": "string",
"maxAgeInSeconds": "int"
}
],
"createMode": "string",
"databaseAccountOfferType": "Standard",
"defaultIdentity": "string",
"disableKeyBasedMetadataWriteAccess": "bool",
"disableLocalAuth": "bool",
"enableAnalyticalStorage": "bool",
"enableAutomaticFailover": "bool",
"enableCassandraConnector": "bool",
"enableFreeTier": "bool",
"enableMultipleWriteLocations": "bool",
"enablePartitionMerge": "bool",
"ipRules": [
{
"ipAddressOrRange": "string"
}
],
"isVirtualNetworkFilterEnabled": "bool",
"keyVaultKeyUri": "string",
"locations": [
{
"failoverPriority": "int",
"isZoneRedundant": "bool",
"locationName": "string"
}
],
"networkAclBypass": "string",
"networkAclBypassResourceIds": [ "string" ],
"publicNetworkAccess": "string",
"restoreParameters": {
"databasesToRestore": [
{
"collectionNames": [ "string" ],
"databaseName": "string"
}
],
"restoreMode": "PointInTime",
"restoreSource": "string",
"restoreTimestampInUtc": "string"
},
"virtualNetworkRules": [
{
"id": "string",
"ignoreMissingVNetServiceEndpoint": "bool"
}
]
}
}
Объекты BackupPolicy
Задайте свойство type , чтобы указать тип объекта .
Для непрерывного использования используйте:
"type": "Continuous"
В параметре Periodic используйте:
"type": "Periodic",
"periodicModeProperties": {
"backupIntervalInMinutes": "int",
"backupRetentionIntervalInHours": "int",
"backupStorageRedundancy": "string"
}
Значения свойств
databaseAccounts
| Имя | Описание | Значение |
|---|---|---|
| тип | Тип ресурса | Microsoft.DocumentDB/databaseAccounts |
| версия_API | Версия API ресурсов | '2022-08-15' |
| name | имя ресурса. | строка (обязательно) Ограничение символов: 3–44 Допустимые символы: Строчные буквы, цифры и дефисы. Начинается со строчной буквы или цифры. Имя ресурса должно быть уникальным в Azure. |
| location | Расположение группы ресурсов, к которой принадлежит ресурс. | строка |
| tags | Теги — это список пар "ключ-значение", описывающих ресурс. Эти теги можно использовать при просмотре и группировании ресурсов (между группами). Для ресурса можно указать не более 15 тегов. В каждом теге длина ключа нее должна превышать 128 символов, а длина значения — 256 символов. Например, для типа шаблона по умолчанию задано значение defaultExperience: Cassandra. Текущие значения defaultExperience также включают "Table", "Graph", "DocumentDB" и "MongoDB". | Словарь имен и значений тегов. См . раздел Теги в шаблонах |
| kind | Указывает тип учетной записи базы данных. Это можно задать только при создании учетной записи базы данных. | GlobalDocumentDB MongoDB "Синтаксический анализ" |
| удостоверение | Удостоверение ресурса. | Управляемое удостоверение службы |
| properties | Свойства для создания и обновления учетных записей базы данных Azure Cosmos DB. | DatabaseAccountCreateUpdatePropertiesOrDatabaseAccou... (обязательно) |
Управляемое удостоверение службы
| Имя | Описание | Значение |
|---|---|---|
| тип | Тип удостоверения, используемого для ресурса. Тип SystemAssigned,UserAssigned включает как неявно созданное удостоверение, так и набор удостоверений, назначаемых пользователем. Тип None удалит все удостоверения из службы. | "Нет" SystemAssigned "SystemAssigned,UserAssigned" UserAssigned |
| userAssignedIdentities | Список удостоверений пользователей, связанных с ресурсом. Ссылки на ключ словаря удостоверений пользователей будут иметь идентификаторы ресурсов ARM в формате "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". | ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
| Имя | Описание | Значение |
|---|---|---|
| {настроенное свойство} | Components1Jq1T4ISchemasManagedserviceidentityProper... |
Components1Jq1T4ISchemasManagedserviceidentityProper...
Этот объект не содержит свойств, которые необходимо задать во время развертывания. Все свойства доступны только для чтения.
DatabaseAccountCreateUpdatePropertiesOrDatabaseAccou...
| Имя | Описание | Значение |
|---|---|---|
| analyticStorageConfiguration | Свойства аналитического хранилища. | AnalyticStorageConfiguration |
| apiProperties | Свойства API. В настоящее время поддерживается только для API MongoDB. | ApiProperties |
| backupPolicy | Объект , представляющий политику для создания резервных копий в учетной записи. | BackupPolicy |
| capabilities | Список возможностей Cosmos DB для учетной записи | Возможность[] |
| Емкость | Объект , представляющий все свойства, связанные с применением емкости в учетной записи. | Производительность |
| connectorOffer | Тип предложения соединителя cassandra для учетной записи C* базы данных Cosmos DB. | 'Маленький' |
| consistencyPolicy | Политика согласованности для учетной записи Cosmos DB. | ConsistencyPolicy |
| cors | Политика CORS для учетной записи базы данных Cosmos DB. | CorsPolicy[] |
| createMode | Перечисление для указания режима создания учетной записи. | 'Default' "Восстановить" |
| databaseAccountOfferType | Тип предложения для базы данных | "Стандартный" (обязательно) |
| defaultIdentity | Удостоверение по умолчанию для доступа к хранилищу ключей, используемое в таких функциях, как управляемые клиентом ключи. Удостоверение по умолчанию должно быть явно задано пользователями. Это может быть FirstPartyIdentity, SystemAssignedIdentity и многое другое. | строка |
| disableKeyBasedMetadataWriteAccess | Отключение операций записи с ресурсами метаданных (базами данных, контейнерами, пропускной способностью) с помощью ключей учетной записи | bool |
| disableLocalAuth | Отключитесь от локальной проверки подлинности и убедитесь, что для проверки подлинности можно использовать только MSI и AAD. | bool |
| enableAnalyticalStorage | Флаг, указывающий, следует ли включать аналитику хранилища. | bool |
| enableAutomaticFailover | Включает автоматическую отработку отказа региона записи в редких случаях, когда регион становится недоступным из-за сбоя. Автоматическая отработка отказа приведет к созданию нового региона записи для учетной записи и будет выбрана на основе приоритетов отработки отказа, настроенных для учетной записи. | bool |
| enableCassandraConnector | Включает соединитель cassandra в учетной записи C* Cosmos DB. | bool |
| enableFreeTier | Флаг, указывающий, включен ли уровень "Бесплатный". | bool |
| enableMultipleWriteLocations | Позволяет учетной записи выполнять запись в нескольких расположениях. | bool |
| enablePartitionMerge | Флаг, указывающий на включение или отключение функции слияния секций в учетной записи | bool |
| ipRules | Список IpRules. | IpAddressOrRange[] |
| isVirtualNetworkFilterEnabled | Флаг, указывающий, следует ли включать или отключать правила ACL виртуальной сети. | bool |
| keyVaultKeyUri | Универсальный код ресурса (URI) хранилища ключей | строка |
| Расположения | Массив, содержащий расположения георепликации, включенные для учетной записи Cosmos DB. | Location[] (обязательно) |
| networkAclBypass | Указывает, какие службы могут обходить проверки брандмауэра. | AzureServices "Нет" |
| networkAclBypassResourceIds | Массив, содержащий идентификаторы ресурсов для обхода сетевого списка ACL для учетной записи Cosmos DB. | string[] |
| publicNetworkAccess | Разрешены ли запросы из общедоступной сети | "Отключено" "Включено" |
| restoreParameters | Параметры, указывающие сведения о восстановлении. | RestoreParameters |
| virtualNetworkRules | Список правил ACL виртуальной сети, настроенных для учетной записи Cosmos DB. | VirtualNetworkRule[] |
AnalyticStorageConfiguration
| Имя | Описание | Значение |
|---|---|---|
| schemaType | Описывает типы схемы для аналитического хранилища. | 'FullFidelity' 'WellDefined' |
ApiProperties
| Имя | Описание | Значение |
|---|---|---|
| serverVersion | Описывает ServerVersion учетной записи MongoDB. | '3.2' '3.6' '4.0' '4.2' |
BackupPolicy
| Имя | Описание | Значение |
|---|---|---|
| migrationState | Объект , представляющий состояние миграции между политиками резервного копирования. | BackupPolicyMigrationState |
| тип | Установка типа объекта | Непрерывные Периодическая (обязательно) |
BackupPolicyMigrationState
| Имя | Описание | Значение |
|---|---|---|
| startTime | Время начала миграции политики резервного копирования (формат ISO-8601). | строка |
| status | Описывает состояние миграции между типами политик резервного копирования. | "Завершено" "Сбой" InProgress "Недопустимый" |
| targetType | Описывает тип целевой политики резервного копирования для миграции политики резервного копирования. | Непрерывный "Периодическая" |
ContinuousModeBackupPolicy
| Имя | Описание | Значение |
|---|---|---|
| тип | Описывает режим резервного копирования. | Continuous (обязательный) |
PeriodicModeBackupPolicy
| Имя | Описание | Значение |
|---|---|---|
| тип | Описывает режим резервного копирования. | "Periodic" (обязательно) |
| periodicModeProperties | Значения конфигурации для резервного копирования в периодическом режиме | PeriodicModeProperties |
PeriodicModeProperties
| Имя | Описание | Значение |
|---|---|---|
| backupIntervalInMinutes | Целое число, представляющее интервал между двумя резервными копиями в минутах. | INT Ограничения: Минимальное значение = 0 |
| backupRetentionIntervalInHours | Целое число, представляющее время (в часах) хранения каждой резервной копии. | INT Ограничения: Минимальное значение = 0 |
| backupStorageRedundancy | Перечисление для указания типа места расположения резервной копии | "Географическое расположение" "Локальный" "Зона" |
Функция
| Имя | Описание | Значение |
|---|---|---|
| name | Имя возможности Cosmos DB. Например, "name": "EnableCassandra". Текущие значения также включают "EnableTable" и "EnableGremlin". | строка |
Capacity
| Имя | Описание | Значение |
|---|---|---|
| totalThroughputLimit | Общее ограничение пропускной способности, установленное для учетной записи. TotalThroughputLimit 2000 устанавливает строгое ограничение максимальной пропускной способности, которое может быть подготовлено для этой учетной записи до 2000. Значение totalThroughputLimit в -1 указывает на отсутствие ограничений на подготовку пропускной способности. | INT |
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 |
CorsPolicy
| Имя | Описание | Значение |
|---|---|---|
| allowedHeaders | Заголовки запросов, которые исходный домен может указывать в запросах CORS. | строка |
| allowedMethods | Методы (команды HTTP-запросов), которые может использовать исходный домен для выполнения запроса CORS. | строка |
| allowedOrigins | Домены источника, которым разрешено выполнять запрос к службе через CORS. | строка (обязательно) |
| exposedHeaders | Заголовки ответов, которые можете отправить в ответ на запрос CORS и предоставить отправителю запроса с помощью браузера. | строка |
| maxAgeInSeconds | Максимальная продолжительность хранения предварительных запросов OPTIONS в кэше браузера. | INT Ограничения: Минимальное значение = 1 Максимальное значение = 2147483647 |
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 | Имя области. | строка |
RestoreParameters
| Имя | Описание | Значение |
|---|---|---|
| databasesToRestore | Список конкретных баз данных, доступных для восстановления. | DatabaseRestoreResource[] |
| restoreMode | Описывает режим восстановления. | PointInTime |
| restoreSource | Идентификатор восстанавливаемой учетной записи базы данных, из которой должно быть инициировано восстановление. Например: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} | строка |
| restoreTimestampInUtc | Время восстановления учетной записи (формат ISO-8601). | строка |
DatabaseRestoreResource
| Имя | Описание | Значение |
|---|---|---|
| collectionNames | Имена коллекций, доступных для восстановления. | string[] |
| databaseName | Имя базы данных, доступной для восстановления. | строка |
VirtualNetworkRule
| Имя | Описание | Значение |
|---|---|---|
| идентификатор | Идентификатор ресурса подсети, например: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. | строка |
| ignoreMissingVNetServiceEndpoint | Создайте правило брандмауэра до включения конечной точки службы виртуальной сети. | bool |
Шаблоны быстрого запуска
Следующие шаблоны быстрого запуска развертывают этот тип ресурса.
| Шаблон | Описание |
|---|---|
| CI/CD с использованием Jenkins в Службе контейнеров Azure (AKS) |
Контейнеры упрощают непрерывную сборку и развертывание приложений. Управляя развертыванием этих контейнеров с помощью Kubernetes в Службе контейнеров Azure, вы можете создать реплицируемые управляемые кластеры контейнеров. Настроив непрерывную сборку для создания образов контейнеров и оркестрации, вы можете повысить скорость и надежность развертывания. |
| Веб-приложение с базой данных SQL, Azure Cosmos DB, поискОм Azure |
Этот шаблон подготавливает веб-приложение, базу данных SQL, Azure Cosmos DB, поиск Azure и Application Insights. |
| Создание учетной записи Azure Cosmos DB для API Cassandra |
Этот шаблон создает учетную запись Azure Cosmos DB для API Cassandra в двух регионах с пространством ключей и таблицей с выделенной пропускной способностью. |
| Создание учетной записи автомасштабирования Azure Cosmos DB для API Cassandra |
Этот шаблон создает учетную запись Azure Cosmos DB для API Cassandra в двух регионах с пространством ключей и таблицей с автомасштабируемой пропускной способностью. |
| Создание учетной записи Azure CosmosDB |
Этот шаблон ARM предназначен для быстрого создания учетной записи CosmosDB с минимальными необходимыми значениями. |
| Создание учетной записи Azure Cosmos DB в нескольких регионах |
Этот шаблон создает учетную запись Azure Cosmos DB для любого типа API базы данных с основным и вторичным регионами с выбором уровня согласованности и типа отработки отказа. |
| Создание учетной записи Azure Cosmos DB бесплатного уровня |
Этот шаблон создает учетную запись Azure Cosmos DB бесплатного уровня для API SQL с базой данных с общей пропускной способностью и контейнером. |
| Создание учетной записи Azure Cosmos DB для API Gremlin |
Этот шаблон создает учетную запись Azure Cosmos DB для API Gremlin в двух регионах с одной базой данных и одним графом с использованием выделенной пропускной способности. |
| Создание учетной записи Azure Cosmos DB для автомасштабирования API Gremlin |
Этот шаблон создает учетную запись Azure Cosmos DB для API Gremlin в двух регионах с одной базой данных и одним графом с использованием автомасштабируемой пропускной способности. |
| Создание учетной записи Azure Cosmos для API MongoDB |
Этот шаблон создает учетную запись Azure Cosmos DB для API MongoDB 4.2 в двух регионах с использованием общей и выделенной пропускной способности с двумя коллекциями. |
| Создание учетной записи Azure Cosmos для автомасштабирования API MongoDB |
Этот шаблон создает учетную запись Azure Cosmos DB для API MongoDB 4.2 в двух регионах с использованием общей и выделенной пропускной способности автомасштабирования. |
| Создание учетной записи Azure Cosmos DB с частной конечной точкой |
Этот шаблон создаст учетную запись Cosmos, виртуальную сеть и частную конечную точку, предоставляющую учетную запись Cosmos виртуальной сети. |
| Создание учетной записи Azure Cosmos DB для API Core (SQL) |
Этот шаблон создает учетную запись Azure Cosmos для API Core (SQL) с базой данных и контейнером с пропускной способностью с несколькими другими вариантами. |
| API SQL учетной записи Azure Cosmos DB с аналитическим хранилищем |
Этот шаблон создает учетную запись Azure Cosmos для API Core (SQL) с базой данных и контейнером, настроенными с аналитическим хранилищем. |
| Создание API SQL учетной записи Azure Cosmos DB с автомасштабированием |
Этот шаблон создает учетную запись Azure Cosmos для API Core (SQL) с базой данных и контейнером с автомасштабируемой пропускной способностью с несколькими другими вариантами. |
| Создание хранимых процедур API Azure Cosmos DB Core (SQL) |
Этот шаблон создает учетную запись Azure Cosmos DB для API Core (SQL) и контейнер с хранимой процедурой, триггером и определяемой пользователем функцией. |
| Создание минимальной учетной записи Azure Cosmos DB для API Core (SQL) |
Этот шаблон создает учетную запись Azure Cosmos DB для API Core (SQL) с указанием только минимальных обязательных свойств ресурса. |
| Создание Azure Cosmos с ПОМОЩЬЮ API SQL и нескольких контейнеров |
Шаблон создает контейнер Cosmos с API SQL и позволяет добавлять многообразные контейнеры. |
| Создание учетной записи SQL Azure Cosmos DB с помощью RBAC плоскости данных |
Этот шаблон создает учетную запись SQL Cosmos DB, встроенное определение роли и встроенное назначение роли для удостоверения Azure Active Directory. |
| Создание бессерверной учетной записи Azure Cosmos DB для API SQL |
Этот шаблон создает бессерверную учетную запись Azure Cosmos DB для API Core (SQL). |
| Создание учетной записи Azure Cosmos для API таблиц |
Этот шаблон создает учетную запись Azure Cosmos DB для API таблиц в двух регионах и одну таблицу с подготовленной пропускной способностью. |
| Создание учетной записи Azure Cosmos для API таблиц с автомасштабированием |
Этот шаблон создает учетную запись Azure Cosmos DB для API таблиц в двух регионах и одну таблицу с автомасштабируемой пропускной способностью. |
| Создание учетной записи Azure Cosmos и веб-приложения Azure |
Этот шаблон создает учетную запись Azure Cosmos, внедряет конечную точку и ключи Cosmos DB в параметры веб-приложения Azure, а затем развертывает веб-приложение ASP MVC из GitHub. |
| Создание учетной записи 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 Data Explorer DB с подключением к Cosmos DB |
Развертывание Azure Data Explorer DB с подключением к Cosmos DB. |
| Учетная запись Azure Cosmos DB с веб-приложением |
Этот шаблон развертывает учетную запись Azure Cosmos DB, план службы приложений и создает веб-приложение в плане службы приложений. Он также добавляет два параметра приложения в веб-приложение, которые ссылаться на конечную точку учетной записи Azure Cosmos DB. Таким образом, решения, развернутые в веб-приложении, могут подключаться к конечной точке учетной записи Azure Cosmos DB с помощью этих параметров. |
Определение ресурса Terraform (поставщик AzAPI)
Тип ресурса databaseAccounts можно развернуть с помощью операций, предназначенных для:
- Группы ресурсов
Список измененных свойств в каждой версии API см. в журнале изменений.
Формат ресурсов
Чтобы создать ресурс Microsoft.DocumentDB/databaseAccounts, добавьте следующую terraform в шаблон.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/databaseAccounts@2022-08-15"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
identity {
type = "string"
identity_ids = []
}
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
}
connectorOffer = "Small"
consistencyPolicy = {
defaultConsistencyLevel = "string"
maxIntervalInSeconds = int
maxStalenessPrefix = int
}
cors = [
{
allowedHeaders = "string"
allowedMethods = "string"
allowedOrigins = "string"
exposedHeaders = "string"
maxAgeInSeconds = int
}
]
createMode = "string"
databaseAccountOfferType = "Standard"
defaultIdentity = "string"
disableKeyBasedMetadataWriteAccess = bool
disableLocalAuth = bool
enableAnalyticalStorage = bool
enableAutomaticFailover = bool
enableCassandraConnector = bool
enableFreeTier = bool
enableMultipleWriteLocations = bool
enablePartitionMerge = bool
ipRules = [
{
ipAddressOrRange = "string"
}
]
isVirtualNetworkFilterEnabled = bool
keyVaultKeyUri = "string"
locations = [
{
failoverPriority = int
isZoneRedundant = bool
locationName = "string"
}
]
networkAclBypass = "string"
networkAclBypassResourceIds = [
"string"
]
publicNetworkAccess = "string"
restoreParameters = {
databasesToRestore = [
{
collectionNames = [
"string"
]
databaseName = "string"
}
]
restoreMode = "PointInTime"
restoreSource = "string"
restoreTimestampInUtc = "string"
}
virtualNetworkRules = [
{
id = "string"
ignoreMissingVNetServiceEndpoint = bool
}
]
}
kind = "string"
})
}
Объекты BackupPolicy
Задайте свойство type , чтобы указать тип объекта .
Для непрерывного использования используйте:
type = "Continuous"
Для периодического использования используйте:
type = "Periodic"
periodicModeProperties = {
backupIntervalInMinutes = int
backupRetentionIntervalInHours = int
backupStorageRedundancy = "string"
}
Значения свойств
databaseAccounts
| Имя | Описание | Значение |
|---|---|---|
| тип | Тип ресурса | "Microsoft.DocumentDB/databaseAccounts@2022-08-15" |
| name | имя ресурса. | строка (обязательно) Ограничение символов: 3–44 Допустимые символы: Строчные буквы, цифры и дефисы. Начинается со строчной буквы или цифры. Имя ресурса должно быть уникальным в Azure. |
| location | Расположение группы ресурсов, к которой принадлежит ресурс. | строка |
| parent_id | Чтобы выполнить развертывание в группе ресурсов, используйте идентификатор этой группы ресурсов. | строка (обязательно) |
| tags | Теги — это список пар "ключ-значение", описывающих ресурс. Эти теги можно использовать при просмотре и группировании ресурсов (между группами). Для ресурса можно указать не более 15 тегов. В каждом теге длина ключа нее должна превышать 128 символов, а длина значения — 256 символов. Например, для типа шаблона по умолчанию задано значение defaultExperience: Cassandra. Текущие значения defaultExperience также включают "Table", "Graph", "DocumentDB" и "MongoDB". | Словарь имен и значений тегов. |
| kind | Указывает тип учетной записи базы данных. Это можно задать только при создании учетной записи базы данных. | GlobalDocumentDB MongoDB "Анализ" |
| удостоверение | Удостоверение ресурса. | Управляемое удостоверение службы |
| properties | Свойства для создания и обновления учетных записей базы данных Azure Cosmos DB. | DatabaseAccountCreateUpdatePropertiesOrDatabaseAccou... (обязательно) |
Управляемое удостоверение службы
| Имя | Описание | Значение |
|---|---|---|
| тип | Тип удостоверения, используемого для ресурса. Тип SystemAssigned,UserAssigned включает как неявно созданное удостоверение, так и набор удостоверений, назначаемых пользователем. Тип None удалит все удостоверения из службы. | "SystemAssigned" "SystemAssigned,UserAssigned" UserAssigned |
| identity_ids | Список удостоверений пользователей, связанных с ресурсом. Ссылки на ключ словаря удостоверений пользователей будут иметь идентификаторы ресурсов ARM в формате "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". | Массив идентификаторов удостоверений пользователей. |
ManagedServiceIdentityUserAssignedIdentities
| Имя | Описание | Значение |
|---|---|---|
| {настроенное свойство} | Components1Jq1T4ISchemasManagedserviceidentityProper... |
Components1Jq1T4ISchemasManagedserviceidentityProper...
Этот объект не содержит свойств, которые необходимо задать во время развертывания. Все свойства доступны только для чтения.
DatabaseAccountCreateUpdatePropertiesOrDatabaseAccou...
| Имя | Описание | Значение |
|---|---|---|
| analyticStorageConfiguration | Свойства аналитического хранилища. | AnalyticStorageConfiguration |
| apiProperties | Свойства API. В настоящее время поддерживается только для API MongoDB. | ApiProperties |
| backupPolicy | Объект , представляющий политику для создания резервных копий в учетной записи. | BackupPolicy |
| capabilities | Список возможностей Cosmos DB для учетной записи | Возможность[] |
| Емкость | Объект , представляющий все свойства, связанные с принудительным применением емкости в учетной записи. | Производительность |
| connectorOffer | Тип предложения соединителя cassandra для учетной записи C* базы данных Cosmos DB. | "Маленький" |
| consistencyPolicy | Политика согласованности для учетной записи Cosmos DB. | ConsistencyPolicy |
| cors | Политика CORS для учетной записи базы данных Cosmos DB. | CorsPolicy[] |
| createMode | Перечисление для указания режима создания учетной записи. | "По умолчанию" "Восстановление" |
| databaseAccountOfferType | Тип предложения для базы данных | "Стандартный" (обязательно) |
| defaultIdentity | Удостоверение по умолчанию для доступа к хранилищу ключей, используемое в таких функциях, как управляемые клиентом ключи. Удостоверение по умолчанию должно быть явно задано пользователями. Это может быть FirstPartyIdentity, SystemAssignedIdentity и многое другое. | строка |
| disableKeyBasedMetadataWriteAccess | Отключение операций записи с ресурсами метаданных (базами данных, контейнерами, пропускной способностью) с помощью ключей учетной записи | bool |
| disableLocalAuth | Отключитесь от локальной проверки подлинности и убедитесь, что для проверки подлинности можно использовать только MSI и AAD. | bool |
| enableAnalyticalStorage | Флаг, указывающий, следует ли включать аналитику хранилища. | bool |
| enableAutomaticFailover | Включает автоматическую отработку отказа региона записи в редких случаях, когда регион становится недоступным из-за сбоя. Автоматическая отработка отказа приведет к созданию нового региона записи для учетной записи и будет выбрана на основе приоритетов отработки отказа, настроенных для учетной записи. | bool |
| enableCassandraConnector | Включает соединитель cassandra в учетной записи C* Cosmos DB. | bool |
| enableFreeTier | Флаг, указывающий, включен ли уровень "Бесплатный". | bool |
| enableMultipleWriteLocations | Позволяет учетной записи выполнять запись в нескольких расположениях. | bool |
| enablePartitionMerge | Флаг, указывающий на включение или отключение функции слияния секций в учетной записи | bool |
| ipRules | Список IpRules. | IpAddressOrRange[] |
| isVirtualNetworkFilterEnabled | Флаг, указывающий, следует ли включать или отключать правила ACL виртуальной сети. | bool |
| keyVaultKeyUri | Универсальный код ресурса (URI) хранилища ключей | строка |
| Расположения | Массив, содержащий расположения георепликации, включенные для учетной записи Cosmos DB. | Location[] (обязательно) |
| networkAclBypass | Указывает, какие службы могут обходить проверки брандмауэра. | "AzureServices" "None" |
| networkAclBypassResourceIds | Массив, содержащий идентификаторы ресурсов для обхода сетевого списка ACL для учетной записи Cosmos DB. | string[] |
| publicNetworkAccess | Разрешены ли запросы из общедоступной сети | "Отключено" "Включено" |
| restoreParameters | Параметры, указывающие сведения о восстановлении. | RestoreParameters |
| virtualNetworkRules | Список правил ACL виртуальной сети, настроенных для учетной записи Cosmos DB. | VirtualNetworkRule[] |
AnalyticStorageConfiguration
| Имя | Описание | Значение |
|---|---|---|
| schemaType | Описывает типы схемы для аналитического хранилища. | "FullFidelity" "WellDefined" |
ApiProperties
| Имя | Описание | Значение |
|---|---|---|
| serverVersion | Описывает ServerVersion учетной записи MongoDB. | "3.2" "3.6" "4.0" "4.2" |
BackupPolicy
| Имя | Описание | Значение |
|---|---|---|
| migrationState | Объект , представляющий состояние миграции между политиками резервного копирования. | BackupPolicyMigrationState |
| тип | Установка типа объекта | Непрерывные Периодическая (обязательно) |
BackupPolicyMigrationState
| Имя | Описание | Значение |
|---|---|---|
| startTime | Время начала миграции политики резервного копирования (формат ISO-8601). | строка |
| status | Описывает состояние миграции между типами политик резервного копирования. | "Завершено" "Сбой" "InProgress" "Недопустимый" |
| targetType | Описывает тип целевой политики резервного копирования для миграции политики резервного копирования. | "Непрерывный" "Периодическая" |
ContinuousModeBackupPolicy
| Имя | Описание | Значение |
|---|---|---|
| тип | Описывает режим резервного копирования. | "Непрерывный" (обязательно) |
PeriodicModeBackupPolicy
| Имя | Описание | Значение |
|---|---|---|
| тип | Описывает режим резервного копирования. | "Periodic" (обязательно) |
| periodicModeProperties | Значения конфигурации для резервного копирования в периодическом режиме | PeriodicModeProperties |
PeriodicModeProperties
| Имя | Описание | Значение |
|---|---|---|
| backupIntervalInMinutes | Целое число, представляющее интервал между двумя резервными копиями в минутах. | INT Ограничения: Минимальное значение = 0 |
| backupRetentionIntervalInHours | Целое число, представляющее время (в часах) хранения каждой резервной копии. | INT Ограничения: Минимальное значение = 0 |
| backupStorageRedundancy | Перечисление для указания типа места расположения резервной копии | "Географическое расположение" "Local" "Зона" |
Функция
| Имя | Описание | Значение |
|---|---|---|
| name | Имя возможности Cosmos DB. Например, "name": "EnableCassandra". Текущие значения также включают "EnableTable" и "EnableGremlin". | строка |
Capacity
| Имя | Описание | Значение |
|---|---|---|
| totalThroughputLimit | Общее ограничение пропускной способности, установленное для учетной записи. TotalThroughputLimit 2000 устанавливает строгое ограничение максимальной пропускной способности, которое может быть подготовлено для этой учетной записи до 2000. Значение totalThroughputLimit в -1 указывает на отсутствие ограничений на подготовку пропускной способности. | INT |
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 |
CorsPolicy
| Имя | Описание | Значение |
|---|---|---|
| allowedHeaders | Заголовки запросов, которые исходный домен может указывать в запросах CORS. | строка |
| allowedMethods | Методы (команды HTTP-запросов), которые может использовать исходный домен для выполнения запроса CORS. | строка |
| allowedOrigins | Домены источника, которым разрешено выполнять запрос к службе через CORS. | строка (обязательно) |
| exposedHeaders | Заголовки ответов, которые можете отправить в ответ на запрос CORS и предоставить отправителю запроса с помощью браузера. | строка |
| maxAgeInSeconds | Максимальная продолжительность хранения предварительных запросов OPTIONS в кэше браузера. | INT Ограничения: Минимальное значение = 1 Максимальное значение = 2147483647 |
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 | Имя области. | строка |
RestoreParameters
| Имя | Описание | Значение |
|---|---|---|
| databasesToRestore | Список конкретных баз данных, доступных для восстановления. | DatabaseRestoreResource[] |
| restoreMode | Описывает режим восстановления. | "PointInTime" |
| restoreSource | Идентификатор восстанавливаемой учетной записи базы данных, из которой должно быть инициировано восстановление. Например: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} | строка |
| restoreTimestampInUtc | Время восстановления учетной записи (формат ISO-8601). | строка |
DatabaseRestoreResource
| Имя | Описание | Значение |
|---|---|---|
| collectionNames | Имена коллекций, доступных для восстановления. | string[] |
| databaseName | Имя базы данных, доступной для восстановления. | строка |
VirtualNetworkRule
| Имя | Описание | Значение |
|---|---|---|
| идентификатор | Идентификатор ресурса подсети, например: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. | строка |
| ignoreMissingVNetServiceEndpoint | Создайте правило брандмауэра до включения конечной точки службы виртуальной сети. | bool |