你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
Microsoft.DocumentDB databaseAccounts 2023-11-15
- 最新
- 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@2023-11-15' = {
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
}
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'
disableKeyBasedMetadataWriteAccess: bool
disableLocalAuth: bool
enableAnalyticalStorage: bool
enableAutomaticFailover: bool
enableBurstCapacity: bool
enableCassandraConnector: bool
enableFreeTier: bool
enableMultipleWriteLocations: bool
enablePartitionMerge: 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'
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'
}
属性值
分析StorageConfiguration
| 名字 | 描述 | 价值 |
|---|---|---|
| schemaType | 描述分析存储的架构类型。 | “FullFidelity” “WellDefined” |
ApiProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| serverVersion | 描述 MongoDB 帐户的 ServerVersion。 | '3.2' '3.6' '4.0' '4.2' |
BackupPolicy
| 名字 | 描述 | 价值 |
|---|---|---|
| migrationState | 表示备份策略之间迁移状态的对象。 | BackupPolicyMigrationState |
| 类型 | 对于 ContinuousModeBackupPolicy类型，设置为“Continuous”。 PeriodicModeBackupPolicy类型设置为“定期”。 | “continuous” “定期”（必需） |
BackupPolicyMigrationState
| 名字 | 描述 | 价值 |
|---|---|---|
| startTime | 备份策略迁移开始的时间（ISO-8601 格式）。 | 字符串 |
| 地位 | 描述备份策略类型之间的迁移状态。 | “Completed” “Failed” “InProgress” “Invalid” |
| targetType | 描述备份策略迁移的目标备份策略类型。 | “continuous” “定期” |
能力
| 名字 | 描述 | 价值 |
|---|---|---|
| 名字 | Cosmos DB 功能的名称。 例如，“name”：“EnableCassandra”。 当前值还包括“EnableTable”和“EnableGremlin”。 | 字符串 |
能力
| 名字 | 描述 | 价值 |
|---|---|---|
| totalThroughputLimit | 对帐户施加的总吞吐量限制。 totalThroughputLimit 为 2000，对可以预配到 2000 的帐户的最大吞吐量施加严格限制。 -1 totalThroughputLimit 表示对预配吞吐量没有限制。 | int 约束： 最小值 = -1 |
Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties
| 名字 | 描述 | 价值 |
|---|
ConsistencyPolicy
| 名字 | 描述 | 价值 |
|---|---|---|
| defaultConsistencyLevel | Cosmos DB 帐户的默认一致性级别和配置设置。 | “BoundedStaleness” “ConsistentPrefix” “最终” “Session” “强”（必需） |
| maxIntervalInSeconds | 与有限过期一致性级别一起使用时，此值表示容忍的过期时间量（以秒为单位）。 此值的接受范围为 5 - 86400。 当 defaultConsistencyPolicy 设置为“BoundedStaleness”时必需。 | int 约束： 最小值 = 5 最大值 = 86400 |
| maxStalenessPrefix | 与有限过期一致性级别一起使用时，此值表示允许的过时请求数。 此值的接受范围为 1 – 2,147,483,647。 当 defaultConsistencyPolicy 设置为“BoundedStaleness”时必需。 | int 约束： 最小值 = 1 最大值 = 2147483647 |
ContinuousModeBackupPolicy
| 名字 | 描述 | 价值 |
|---|---|---|
| continuousModeProperties | 连续模式备份的配置值 | ContinuousModeProperties |
| 类型 | 描述备份模式。 | “连续”（必需） |
ContinuousModeProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| 层 | 枚举以指示连续备份模式的类型 | “Continuous30Days” “Continuous7Days” |
CorsPolicy
| 名字 | 描述 | 价值 |
|---|---|---|
| allowedHeaders | 源域可以在 CORS 请求上指定的请求标头。 | 字符串 |
| allowedMethods | 源域可用于 CORS 请求的方法（HTTP 请求谓词）。 | 字符串 |
| allowedOrigins | 允许通过 CORS 针对服务发出请求的源域。 | string （必需） |
| exposedHeaders | 响应标头，这些标头可能在响应 CORS 请求中发送，并由浏览器向请求颁发者公开。 | 字符串 |
| maxAgeInSeconds | 浏览器应缓存预检 OPTIONS 请求的最大时间。 | int 约束： 最小值 = 1 最大值 = 2147483647 |
DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| 分析StorageConfiguration | 分析存储特定属性。 | 分析StorageConfiguration |
| apiProperties | API 特定属性。 目前，仅 MongoDB API 支持。 | ApiProperties |
| backupPolicy | 表示用于在帐户上备份的策略的对象。 | BackupPolicy |
| 能力 | 帐户的 Cosmos DB 功能列表 | 功能[] |
| 能力 | 表示与帐户上的容量强制实施相关的所有属性的对象。 | 容量 |
| connectorOffer | cassandra 连接器为 Cosmos DB 数据库 C* 帐户提供类型。 | “Small” |
| consistencyPolicy | Cosmos DB 帐户的一致性策略。 | ConsistencyPolicy |
| cors | Cosmos DB 数据库帐户的 CORS 策略。 | CorsPolicy[] |
| createMode | 枚举以指示帐户创建模式。 | “Default” “还原” |
| customerManagedKeyStatus | 指示帐户上客户管理的密钥功能的状态。 如果出现错误，该属性将提供故障排除指南。 | 字符串 |
| databaseAccountOfferType | 数据库的套餐类型 | “标准”（必需） |
| defaultIdentity | 用于访问客户托管密钥等功能中使用的密钥保管库的默认标识。 用户需要显式设置默认标识。 它可以是“FirstPartyIdentity”、“SystemAssignedIdentity”等。 | 字符串 |
| disableKeyBasedMetadataWriteAccess | 通过帐户密钥对元数据资源（数据库、容器、吞吐量）禁用写入操作 | bool |
| disableLocalAuth | 选择退出本地身份验证，并确保只能将 MSI 和 AAD 用于身份验证。 | bool |
| enableAnalyticalStorage | 用于指示是否启用存储分析的标志。 | bool |
| enableAutomaticFailover | 在极少数情况下启用写入区域的自动故障转移，因为服务中断导致该区域不可用。 自动故障转移将导致帐户的新写入区域，并根据为帐户配置的故障转移优先级进行选择。 | bool |
| enableBurstCapacity | 指示在帐户上启用/禁用突发容量功能的标志 | bool |
| enableCassandraConnector | 在 Cosmos DB C* 帐户上启用 cassandra 连接器 | bool |
| enableFreeTier | 用于指示是否启用免费层的标志。 | bool |
| enableMultipleWriteLocations | 使帐户能够在多个位置写入 | bool |
| enablePartitionMerge | 用于指示在帐户上启用/禁用分区合并功能的标志 | bool |
| ipRules | IpRules 列表。 | IpAddressOrRange[] |
| isVirtualNetworkFilterEnabled | 用于指示是否启用/禁用虚拟网络 ACL 规则的标志。 | bool |
| keyVaultKeyUri | 密钥保管库的 URI | 字符串 |
| 地点 | 一个数组，其中包含为 Cosmos DB 帐户启用的地理复制位置。 | 位置[] （必需） |
| minimalTlsVersion | 指示允许的最低 Tls 版本。 默认值为 Tls 1.2。 Cassandra 和 Mongo API 仅适用于 Tls 1.2。 | “Tls” “Tls11” “Tls12” |
| networkAclBypass | 指示允许哪些服务绕过防火墙检查。 | “AzureServices” “None” |
| networkAclBypassResourceIds | 一个数组，其中包含 Cosmos DB 帐户的网络 Acl 绕过的资源 ID。 | string[] |
| publicNetworkAccess | 是否允许来自公用网络的请求 | “Disabled” “Enabled” “SecuredByPerimeter” |
| restoreParameters | 用于指示还原信息的参数。 | RestoreParameters |
| virtualNetworkRules | 为 Cosmos DB 帐户配置的虚拟网络 ACL 规则列表。 | VirtualNetworkRule[] |
DatabaseRestoreResource
| 名字 | 描述 | 价值 |
|---|---|---|
| collectionNames | 可用于还原的集合的名称。 | string[] |
| databaseName | 可用于还原的数据库的名称。 | 字符串 |
GremlinDatabaseRestoreResource
| 名字 | 描述 | 价值 |
|---|---|---|
| databaseName | 可用于还原的 gremlin 数据库的名称。 | 字符串 |
| graphNames | 可用于还原的图形的名称。 | string[] |
IpAddressOrRange
| 名字 | 描述 | 价值 |
|---|---|---|
| ipAddressOrRange | 单个 IPv4 地址或 CIDR 格式的单个 IPv4 地址范围。 提供的 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”包括隐式创建的标识和一组用户分配的标识。 类型“None”将从服务中删除任何标识。 | “None” “SystemAssigned” “SystemAssigned，UserAssigned” “UserAssigned” |
| userAssignedIdentities | 与资源关联的用户标识列表。 用户标识字典密钥引用的格式为 ARM 资源 ID：“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。 | ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
| 名字 | 描述 | 价值 |
|---|
Microsoft.DocumentDB/databaseAccounts
| 名字 | 描述 | 价值 |
|---|---|---|
| 身份 | 资源的标识。 | ManagedServiceIdentity |
| 类 | 指示数据库帐户的类型。 只能在创建数据库帐户时设置此设置。 | “GlobalDocumentDB” “MongoDB” “Parse” |
| 位置 | 资源所属的资源组的位置。 | 字符串 |
| 名字 | 资源名称 | 字符串 约束： 最小长度 = 3 最大长度 = 3 模式 = ^[a-z0-9]+(-[a-z0-9]+)* （必需） |
| 性能 | 用于创建和更新 Azure Cosmos DB 数据库帐户的属性。 | DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties （必需） |
| 标签 | 资源标记 | 标记名称和值的字典。 请参阅模板 中的 |
PeriodicModeBackupPolicy
| 名字 | 描述 | 价值 |
|---|---|---|
| periodicModeProperties | 定期模式备份的配置值 | PeriodicModeProperties |
| 类型 | 描述备份模式。 | “定期”（必需） |
PeriodicModeProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| backupIntervalInMinutes | 一个整数，表示两次备份之间的间隔（以分钟为单位） | int 约束： 最小值 = 0 |
| backupRetentionIntervalInHours | 一个整数，表示保留每个备份的时间（以小时为单位） | int 约束： 最小值 = 0 |
| backupStorageRedundancy | 用于指示备份驻留类型的枚举 | “Geo” “Local” “Zone” |
RestoreParameters
| 名字 | 描述 | 价值 |
|---|---|---|
| databasesToRestore | 可用于还原的特定数据库的列表。 | DatabaseRestoreResource[] |
| gremlinDatabasesToRestore | 可用于还原的特定 gremlin 数据库的列表。 | GremlinDatabaseRestoreResource[] |
| restoreMode | 描述还原模式。 | “PointInTime” |
| restoreSource | 必须从中启动还原的可还原数据库帐户的 ID。 例如：/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} | 字符串 |
| restoreTimestampInUtc | 帐户必须还原到的时间（ISO-8601 格式）。 | 字符串 |
| tablesToRestore | 可用于还原的特定表的列表。 | string[] |
标签
| 名字 | 描述 | 价值 |
|---|
VirtualNetworkRule
| 名字 | 描述 | 价值 |
|---|---|---|
| id | 子网的资源 ID，例如：/subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}。 | 字符串 |
| ignoreMissingVNetServiceEndpoint | 在虚拟网络启用 vnet 服务终结点之前创建防火墙规则。 | bool |
快速入门示例
以下快速入门示例部署此资源类型。
| Bicep 文件 | 描述 |
|---|---|
| 使用分析存储 |
此模板为 Core （SQL） API 创建一个 Azure Cosmos 帐户，其中包含配置了分析存储的数据库和容器。 |
| 使用 Web 应用 |
此模板部署 Azure Cosmos DB 帐户、应用服务计划，并在应用服务计划中创建 Web 应用。 它还将两个应用程序设置添加到引用 Azure Cosmos DB 帐户终结点的 Web 应用。 这样，部署到 Web 应用的解决方案就可以使用这些设置连接到 Azure Cosmos DB 帐户终结点。 |
| 创建启用了 Microsoft Defender 的 Cosmos DB 帐户 | 使用此 ARM 模板，可以部署启用了 Microsoft Defender for Azure Cosmos DB 的 Azure Cosmos DB 帐户。 Microsoft Defender for Azure Cosmos DB 是一个 Azure 原生安全层，用于检测尝试利用 Azure Cosmos DB 帐户中的数据库。 Microsoft Defender for Azure Cosmos DB 根据Microsoft威胁情报、可疑访问模式以及通过泄露的标识或恶意预览体验成员对数据库的潜在攻击来检测潜在的 SQL 注入、已知不良参与者。 |
| 创建免费层 Azure Cosmos DB 帐户 | 此模板使用具有共享吞吐量和容器的数据库为 SQL API 创建免费层 Azure Cosmos DB 帐户。 |
| 为 Core （SQL） API 创建最小 Azure Cosmos DB 帐户 | 此模板为 Core （SQL） API 创建 Azure Cosmos DB 帐户，同时仅指定所需的最少资源属性。 |
| 为 SQL API 创建无服务器 Azure Cosmos DB 帐户 | 此模板为 Core （SQL） API 创建无服务器 Azure Cosmos DB 帐户。 |
| 创建零接触 Azure Cosmos 帐户和 Azure Web 应用 | 此模板创建 Azure Cosmos 帐户，将 Cosmos DB 终结点和密钥注入 Azure Web 应用设置，然后从 GitHub 部署 ASP MVC Web 应用。 |
| 为 MongoDB API 创建 Azure Cosmos 帐户 | 此模板使用具有两个集合的共享吞吐量和专用吞吐量，在两个区域中为 MongoDB API 4.2 创建 Azure Cosmos DB 帐户。 |
| 为 MongoDB API 自动缩放创建 Azure Cosmos 帐户 | 此模板使用共享和专用自动缩放吞吐量在两个区域中为 MongoDB API 4.2 创建 Azure Cosmos DB 帐户。 |
| 为表 API 创建 Azure Cosmos 帐户 | 此模板在两个区域中为表 API 创建一个 Azure Cosmos DB 帐户，以及一个具有预配吞吐量的表。 |
| 使用自动缩放 为表 API 创建 Azure Cosmos 帐户 | 此模板在两个区域中为表 API 创建一个 Azure Cosmos DB 帐户，以及一个具有自动缩放吞吐量的表。 |
| 为 Cassandra API 创建 Azure Cosmos DB 帐户 | 此模板在具有密钥空间和具有专用吞吐量的表的两个区域中为 Cassandra API 创建 Azure Cosmos DB 帐户。 |
| 为 Core （SQL） API 创建 Azure Cosmos DB 帐户 | 此模板创建一个 Azure Cosmos 帐户，用于 Core （SQL） API，其中包含具有多个其他选项的吞吐量的数据库和容器。 |
| 为 Gremlin API 创建 Azure Cosmos DB 帐户 | 此模板使用专用吞吐量在两个区域中为 Gremlin API 创建 Azure Cosmos DB 帐户，其中包含一个数据库和一个图形。 |
| 为 Gremlin API 自动缩放 创建 Azure Cosmos DB 帐户 | 此模板使用自动缩放吞吐量在两个区域中为 Gremlin API 创建 Azure Cosmos DB 帐户，其中包含一个数据库和一个图形。 |
| 在多个区域创建 Azure Cosmos DB 帐户 | 此模板为具有选择一致性级别和故障转移类型的主要和次要区域的任何数据库 API 类型创建 Azure Cosmos DB 帐户。 |
| 使用自动缩放 创建 Azure Cosmos DB 帐户 SQL API | 此模板为 Core （SQL） API 创建一个 Azure Cosmos 帐户，该帐户包含具有多个其他选项的自动缩放吞吐量的数据库和容器。 |
| 使用专用终结点创建 Azure Cosmos DB 帐户 | 此模板将创建 Cosmos 帐户、虚拟网络以及向虚拟网络公开 Cosmos 帐户的专用终结点。 |
| 使用数据平面 RBAC 创建 Azure Cosmos DB SQL 帐户 | 此模板将创建 SQL Cosmos 帐户、本机维护的角色定义，以及 AAD 标识的本机维护角色分配。 |
| 创建 Azure CosmosDB 帐户 | 此 ARM 模板旨在快速创建具有最少所需值的 CosmosDB 帐户 |
| 为 Cassandra API 创建自动缩放 Azure Cosmos DB 帐户 | 此模板在具有密钥空间和具有自动缩放吞吐量的表的两个区域中为 Cassandra API 创建 Azure Cosmos DB 帐户。 |
| 创建 Azure Cosmos DB Core （SQL） API 存储过程 | 此模板创建一个用于 Core （SQL） API 的 Azure Cosmos DB 帐户，以及一个包含存储过程、触发器和用户定义的函数的容器。 |
| 使用容器应用创建 Dapr 微服务应用 | 使用容器应用创建 Dapr 微服务应用。 |
| 使用容器应用创建 Dapr pub-sub servicebus 应用 | 使用容器应用创建 Dapr pub-sub servicebus 应用。 |
| 使用 Cosmos DB 连接部署 Azure 数据资源管理器 DB | 使用 Cosmos DB 连接部署 Azure 数据资源管理器 DB。 |
ARM 模板资源定义
可以使用目标操作部署 databaseAccounts 资源类型：
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.DocumentDB/databaseAccounts 资源，请将以下 JSON 添加到模板。
{
"type": "Microsoft.DocumentDB/databaseAccounts",
"apiVersion": "2023-11-15",
"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"
},
"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",
"disableKeyBasedMetadataWriteAccess": "bool",
"disableLocalAuth": "bool",
"enableAnalyticalStorage": "bool",
"enableAutomaticFailover": "bool",
"enableBurstCapacity": "bool",
"enableCassandraConnector": "bool",
"enableFreeTier": "bool",
"enableMultipleWriteLocations": "bool",
"enablePartitionMerge": "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",
"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"
}
属性值
分析StorageConfiguration
| 名字 | 描述 | 价值 |
|---|---|---|
| schemaType | 描述分析存储的架构类型。 | “FullFidelity” “WellDefined” |
ApiProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| serverVersion | 描述 MongoDB 帐户的 ServerVersion。 | '3.2' '3.6' '4.0' '4.2' |
BackupPolicy
| 名字 | 描述 | 价值 |
|---|---|---|
| migrationState | 表示备份策略之间迁移状态的对象。 | BackupPolicyMigrationState |
| 类型 | 对于 ContinuousModeBackupPolicy类型，设置为“Continuous”。 PeriodicModeBackupPolicy类型设置为“定期”。 | “continuous” “定期”（必需） |
BackupPolicyMigrationState
| 名字 | 描述 | 价值 |
|---|---|---|
| startTime | 备份策略迁移开始的时间（ISO-8601 格式）。 | 字符串 |
| 地位 | 描述备份策略类型之间的迁移状态。 | “Completed” “Failed” “InProgress” “Invalid” |
| targetType | 描述备份策略迁移的目标备份策略类型。 | “continuous” “定期” |
能力
| 名字 | 描述 | 价值 |
|---|---|---|
| 名字 | Cosmos DB 功能的名称。 例如，“name”：“EnableCassandra”。 当前值还包括“EnableTable”和“EnableGremlin”。 | 字符串 |
能力
| 名字 | 描述 | 价值 |
|---|---|---|
| totalThroughputLimit | 对帐户施加的总吞吐量限制。 totalThroughputLimit 为 2000，对可以预配到 2000 的帐户的最大吞吐量施加严格限制。 -1 totalThroughputLimit 表示对预配吞吐量没有限制。 | int 约束： 最小值 = -1 |
Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties
| 名字 | 描述 | 价值 |
|---|
ConsistencyPolicy
| 名字 | 描述 | 价值 |
|---|---|---|
| defaultConsistencyLevel | Cosmos DB 帐户的默认一致性级别和配置设置。 | “BoundedStaleness” “ConsistentPrefix” “最终” “Session” “强”（必需） |
| maxIntervalInSeconds | 与有限过期一致性级别一起使用时，此值表示容忍的过期时间量（以秒为单位）。 此值的接受范围为 5 - 86400。 当 defaultConsistencyPolicy 设置为“BoundedStaleness”时必需。 | int 约束： 最小值 = 5 最大值 = 86400 |
| maxStalenessPrefix | 与有限过期一致性级别一起使用时，此值表示允许的过时请求数。 此值的接受范围为 1 – 2,147,483,647。 当 defaultConsistencyPolicy 设置为“BoundedStaleness”时必需。 | int 约束： 最小值 = 1 最大值 = 2147483647 |
ContinuousModeBackupPolicy
| 名字 | 描述 | 价值 |
|---|---|---|
| continuousModeProperties | 连续模式备份的配置值 | ContinuousModeProperties |
| 类型 | 描述备份模式。 | “连续”（必需） |
ContinuousModeProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| 层 | 枚举以指示连续备份模式的类型 | “Continuous30Days” “Continuous7Days” |
CorsPolicy
| 名字 | 描述 | 价值 |
|---|---|---|
| allowedHeaders | 源域可以在 CORS 请求上指定的请求标头。 | 字符串 |
| allowedMethods | 源域可用于 CORS 请求的方法（HTTP 请求谓词）。 | 字符串 |
| allowedOrigins | 允许通过 CORS 针对服务发出请求的源域。 | string （必需） |
| exposedHeaders | 响应标头，这些标头可能在响应 CORS 请求中发送，并由浏览器向请求颁发者公开。 | 字符串 |
| maxAgeInSeconds | 浏览器应缓存预检 OPTIONS 请求的最大时间。 | int 约束： 最小值 = 1 最大值 = 2147483647 |
DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| 分析StorageConfiguration | 分析存储特定属性。 | 分析StorageConfiguration |
| apiProperties | API 特定属性。 目前，仅 MongoDB API 支持。 | ApiProperties |
| backupPolicy | 表示用于在帐户上备份的策略的对象。 | BackupPolicy |
| 能力 | 帐户的 Cosmos DB 功能列表 | 功能[] |
| 能力 | 表示与帐户上的容量强制实施相关的所有属性的对象。 | 容量 |
| connectorOffer | cassandra 连接器为 Cosmos DB 数据库 C* 帐户提供类型。 | “Small” |
| consistencyPolicy | Cosmos DB 帐户的一致性策略。 | ConsistencyPolicy |
| cors | Cosmos DB 数据库帐户的 CORS 策略。 | CorsPolicy[] |
| createMode | 枚举以指示帐户创建模式。 | “Default” “还原” |
| customerManagedKeyStatus | 指示帐户上客户管理的密钥功能的状态。 如果出现错误，该属性将提供故障排除指南。 | 字符串 |
| databaseAccountOfferType | 数据库的套餐类型 | “标准”（必需） |
| defaultIdentity | 用于访问客户托管密钥等功能中使用的密钥保管库的默认标识。 用户需要显式设置默认标识。 它可以是“FirstPartyIdentity”、“SystemAssignedIdentity”等。 | 字符串 |
| disableKeyBasedMetadataWriteAccess | 通过帐户密钥对元数据资源（数据库、容器、吞吐量）禁用写入操作 | bool |
| disableLocalAuth | 选择退出本地身份验证，并确保只能将 MSI 和 AAD 用于身份验证。 | bool |
| enableAnalyticalStorage | 用于指示是否启用存储分析的标志。 | bool |
| enableAutomaticFailover | 在极少数情况下启用写入区域的自动故障转移，因为服务中断导致该区域不可用。 自动故障转移将导致帐户的新写入区域，并根据为帐户配置的故障转移优先级进行选择。 | bool |
| enableBurstCapacity | 指示在帐户上启用/禁用突发容量功能的标志 | bool |
| enableCassandraConnector | 在 Cosmos DB C* 帐户上启用 cassandra 连接器 | bool |
| enableFreeTier | 用于指示是否启用免费层的标志。 | bool |
| enableMultipleWriteLocations | 使帐户能够在多个位置写入 | bool |
| enablePartitionMerge | 用于指示在帐户上启用/禁用分区合并功能的标志 | bool |
| ipRules | IpRules 列表。 | IpAddressOrRange[] |
| isVirtualNetworkFilterEnabled | 用于指示是否启用/禁用虚拟网络 ACL 规则的标志。 | bool |
| keyVaultKeyUri | 密钥保管库的 URI | 字符串 |
| 地点 | 一个数组，其中包含为 Cosmos DB 帐户启用的地理复制位置。 | 位置[] （必需） |
| minimalTlsVersion | 指示允许的最低 Tls 版本。 默认值为 Tls 1.2。 Cassandra 和 Mongo API 仅适用于 Tls 1.2。 | “Tls” “Tls11” “Tls12” |
| networkAclBypass | 指示允许哪些服务绕过防火墙检查。 | “AzureServices” “None” |
| networkAclBypassResourceIds | 一个数组，其中包含 Cosmos DB 帐户的网络 Acl 绕过的资源 ID。 | string[] |
| publicNetworkAccess | 是否允许来自公用网络的请求 | “Disabled” “Enabled” “SecuredByPerimeter” |
| restoreParameters | 用于指示还原信息的参数。 | RestoreParameters |
| virtualNetworkRules | 为 Cosmos DB 帐户配置的虚拟网络 ACL 规则列表。 | VirtualNetworkRule[] |
DatabaseRestoreResource
| 名字 | 描述 | 价值 |
|---|---|---|
| collectionNames | 可用于还原的集合的名称。 | string[] |
| databaseName | 可用于还原的数据库的名称。 | 字符串 |
GremlinDatabaseRestoreResource
| 名字 | 描述 | 价值 |
|---|---|---|
| databaseName | 可用于还原的 gremlin 数据库的名称。 | 字符串 |
| graphNames | 可用于还原的图形的名称。 | string[] |
IpAddressOrRange
| 名字 | 描述 | 价值 |
|---|---|---|
| ipAddressOrRange | 单个 IPv4 地址或 CIDR 格式的单个 IPv4 地址范围。 提供的 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”包括隐式创建的标识和一组用户分配的标识。 类型“None”将从服务中删除任何标识。 | “None” “SystemAssigned” “SystemAssigned，UserAssigned” “UserAssigned” |
| userAssignedIdentities | 与资源关联的用户标识列表。 用户标识字典密钥引用的格式为 ARM 资源 ID：“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。 | ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
| 名字 | 描述 | 价值 |
|---|
Microsoft.DocumentDB/databaseAccounts
| 名字 | 描述 | 价值 |
|---|---|---|
| apiVersion | API 版本 | '2023-11-15' |
| 身份 | 资源的标识。 | ManagedServiceIdentity |
| 类 | 指示数据库帐户的类型。 只能在创建数据库帐户时设置此设置。 | “GlobalDocumentDB” “MongoDB” “Parse” |
| 位置 | 资源所属的资源组的位置。 | 字符串 |
| 名字 | 资源名称 | 字符串 约束： 最小长度 = 3 最大长度 = 3 模式 = ^[a-z0-9]+(-[a-z0-9]+)* （必需） |
| 性能 | 用于创建和更新 Azure Cosmos DB 数据库帐户的属性。 | DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties （必需） |
| 标签 | 资源标记 | 标记名称和值的字典。 请参阅模板 中的 |
| 类型 | 资源类型 | “Microsoft.DocumentDB/databaseAccounts” |
PeriodicModeBackupPolicy
| 名字 | 描述 | 价值 |
|---|---|---|
| periodicModeProperties | 定期模式备份的配置值 | PeriodicModeProperties |
| 类型 | 描述备份模式。 | “定期”（必需） |
PeriodicModeProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| backupIntervalInMinutes | 一个整数，表示两次备份之间的间隔（以分钟为单位） | int 约束： 最小值 = 0 |
| backupRetentionIntervalInHours | 一个整数，表示保留每个备份的时间（以小时为单位） | int 约束： 最小值 = 0 |
| backupStorageRedundancy | 用于指示备份驻留类型的枚举 | “Geo” “Local” “Zone” |
RestoreParameters
| 名字 | 描述 | 价值 |
|---|---|---|
| databasesToRestore | 可用于还原的特定数据库的列表。 | DatabaseRestoreResource[] |
| gremlinDatabasesToRestore | 可用于还原的特定 gremlin 数据库的列表。 | GremlinDatabaseRestoreResource[] |
| restoreMode | 描述还原模式。 | “PointInTime” |
| restoreSource | 必须从中启动还原的可还原数据库帐户的 ID。 例如：/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} | 字符串 |
| restoreTimestampInUtc | 帐户必须还原到的时间（ISO-8601 格式）。 | 字符串 |
| tablesToRestore | 可用于还原的特定表的列表。 | string[] |
标签
| 名字 | 描述 | 价值 |
|---|
VirtualNetworkRule
| 名字 | 描述 | 价值 |
|---|---|---|
| id | 子网的资源 ID，例如：/subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}。 | 字符串 |
| ignoreMissingVNetServiceEndpoint | 在虚拟网络启用 vnet 服务终结点之前创建防火墙规则。 | bool |
快速入门模板
以下快速入门模板部署此资源类型。
| 模板 | 描述 |
|---|---|
使用分析存储 
|
此模板为 Core （SQL） API 创建一个 Azure Cosmos 帐户，其中包含配置了分析存储的数据库和容器。 |
| 使用 Web 应用
|
此模板部署 Azure Cosmos DB 帐户、应用服务计划，并在应用服务计划中创建 Web 应用。 它还将两个应用程序设置添加到引用 Azure Cosmos DB 帐户终结点的 Web 应用。 这样，部署到 Web 应用的解决方案就可以使用这些设置连接到 Azure Cosmos DB 帐户终结点。 |
| 在 Azure 容器服务（AKS）上使用 Jenkins CI/CD
|
容器使你可以轻松地持续生成和部署应用程序。 通过在 Azure 容器服务中使用 Kubernetes 协调这些容器的部署，可以实现可复制、可管理的容器群集。 通过设置持续生成来生成容器映像和业务流程，可以提高部署的速度和可靠性。 |
|
创建启用了 Microsoft Defender 的 Cosmos DB 帐户
|
使用此 ARM 模板，可以部署启用了 Microsoft Defender for Azure Cosmos DB 的 Azure Cosmos DB 帐户。 Microsoft Defender for Azure Cosmos DB 是一个 Azure 原生安全层，用于检测尝试利用 Azure Cosmos DB 帐户中的数据库。 Microsoft Defender for Azure Cosmos DB 根据Microsoft威胁情报、可疑访问模式以及通过泄露的标识或恶意预览体验成员对数据库的潜在攻击来检测潜在的 SQL 注入、已知不良参与者。 |
|
创建免费层 Azure Cosmos DB 帐户
|
此模板使用具有共享吞吐量和容器的数据库为 SQL API 创建免费层 Azure Cosmos DB 帐户。 |
|
为 Core （SQL） API 创建最小 Azure Cosmos DB 帐户
|
此模板为 Core （SQL） API 创建 Azure Cosmos DB 帐户，同时仅指定所需的最少资源属性。 |
|
为 SQL API 创建无服务器 Azure Cosmos DB 帐户
|
此模板为 Core （SQL） API 创建无服务器 Azure Cosmos DB 帐户。 |
|
创建零接触 Azure Cosmos 帐户和 Azure Web 应用
|
此模板创建 Azure Cosmos 帐户，将 Cosmos DB 终结点和密钥注入 Azure Web 应用设置，然后从 GitHub 部署 ASP MVC Web 应用。 |
|
为 MongoDB API 创建 Azure Cosmos 帐户
|
此模板使用具有两个集合的共享吞吐量和专用吞吐量，在两个区域中为 MongoDB API 4.2 创建 Azure Cosmos DB 帐户。 |
|
为 MongoDB API 自动缩放创建 Azure Cosmos 帐户
|
此模板使用共享和专用自动缩放吞吐量在两个区域中为 MongoDB API 4.2 创建 Azure Cosmos DB 帐户。 |
|
为表 API 创建 Azure Cosmos 帐户
|
此模板在两个区域中为表 API 创建一个 Azure Cosmos DB 帐户，以及一个具有预配吞吐量的表。 |
|
使用自动缩放 为表 API 创建 Azure Cosmos 帐户
|
此模板在两个区域中为表 API 创建一个 Azure Cosmos DB 帐户，以及一个具有自动缩放吞吐量的表。 |
|
为 Cassandra API 创建 Azure Cosmos DB 帐户
|
此模板在具有密钥空间和具有专用吞吐量的表的两个区域中为 Cassandra API 创建 Azure Cosmos DB 帐户。 |
|
为 Core （SQL） API 创建 Azure Cosmos DB 帐户
|
此模板创建一个 Azure Cosmos 帐户，用于 Core （SQL） API，其中包含具有多个其他选项的吞吐量的数据库和容器。 |
|
为 Gremlin API 创建 Azure Cosmos DB 帐户
|
此模板使用专用吞吐量在两个区域中为 Gremlin API 创建 Azure Cosmos DB 帐户，其中包含一个数据库和一个图形。 |
|
为 Gremlin API 自动缩放 创建 Azure Cosmos DB 帐户
|
此模板使用自动缩放吞吐量在两个区域中为 Gremlin API 创建 Azure Cosmos DB 帐户，其中包含一个数据库和一个图形。 |
|
在多个区域创建 Azure Cosmos DB 帐户
|
此模板为具有选择一致性级别和故障转移类型的主要和次要区域的任何数据库 API 类型创建 Azure Cosmos DB 帐户。 |
|
使用自动缩放 创建 Azure Cosmos DB 帐户 SQL API
|
此模板为 Core （SQL） API 创建一个 Azure Cosmos 帐户，该帐户包含具有多个其他选项的自动缩放吞吐量的数据库和容器。 |
|
使用专用终结点创建 Azure Cosmos DB 帐户
|
此模板将创建 Cosmos 帐户、虚拟网络以及向虚拟网络公开 Cosmos 帐户的专用终结点。 |
|
使用数据平面 RBAC 创建 Azure Cosmos DB SQL 帐户
|
此模板将创建 SQL Cosmos 帐户、本机维护的角色定义，以及 AAD 标识的本机维护角色分配。 |
|
创建 Azure CosmosDB 帐户
|
此 ARM 模板旨在快速创建具有最少所需值的 CosmosDB 帐户 |
|
为 Cassandra API 创建自动缩放 Azure Cosmos DB 帐户
|
此模板在具有密钥空间和具有自动缩放吞吐量的表的两个区域中为 Cassandra API 创建 Azure Cosmos DB 帐户。 |
|
创建 Azure Cosmos DB Core （SQL） API 存储过程
|
此模板创建一个用于 Core （SQL） API 的 Azure Cosmos DB 帐户，以及一个包含存储过程、触发器和用户定义的函数的容器。 |
|
使用 SQL API 和多个容器创建 Azure Cosmos
|
该模板使用 SQL API 创建 Cosmos 容器，并允许添加多个容器。 |
|
使用容器应用创建 Dapr 微服务应用
|
使用容器应用创建 Dapr 微服务应用。 |
|
使用容器应用创建 Dapr pub-sub servicebus 应用
|
使用容器应用创建 Dapr pub-sub servicebus 应用。 |
|
使用 Cosmos DB 连接部署 Azure 数据资源管理器 DB
|
使用 Cosmos DB 连接部署 Azure 数据资源管理器 DB。 |
| 使用 SQL 数据库、Azure Cosmos DB、Azure 搜索
|
此模板预配 Web 应用、SQL 数据库、Azure Cosmos DB、Azure 搜索和 Application Insights。 |
Terraform （AzAPI 提供程序）资源定义
可以使用目标操作部署 databaseAccounts 资源类型：
- 资源组
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.DocumentDB/databaseAccounts 资源，请将以下 Terraform 添加到模板。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/databaseAccounts@2023-11-15"
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
}
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"
disableKeyBasedMetadataWriteAccess = bool
disableLocalAuth = bool
enableAnalyticalStorage = bool
enableAutomaticFailover = bool
enableBurstCapacity = bool
enableCassandraConnector = bool
enableFreeTier = bool
enableMultipleWriteLocations = bool
enablePartitionMerge = 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"
tablesToRestore = [
"string"
]
}
virtualNetworkRules = [
{
id = "string"
ignoreMissingVNetServiceEndpoint = bool
}
]
}
})
}
BackupPolicy 对象
设置 类型 属性以指定对象的类型。
对于 连续，请使用：
{
continuousModeProperties = {
tier = "string"
}
type = "Continuous"
}
对于 定期，请使用：
{
periodicModeProperties = {
backupIntervalInMinutes = int
backupRetentionIntervalInHours = int
backupStorageRedundancy = "string"
}
type = "Periodic"
}
属性值
分析StorageConfiguration
| 名字 | 描述 | 价值 |
|---|---|---|
| schemaType | 描述分析存储的架构类型。 | “FullFidelity” “WellDefined” |
ApiProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| serverVersion | 描述 MongoDB 帐户的 ServerVersion。 | '3.2' '3.6' '4.0' '4.2' |
BackupPolicy
| 名字 | 描述 | 价值 |
|---|---|---|
| migrationState | 表示备份策略之间迁移状态的对象。 | BackupPolicyMigrationState |
| 类型 | 对于 ContinuousModeBackupPolicy类型，设置为“Continuous”。 PeriodicModeBackupPolicy类型设置为“定期”。 | “continuous” “定期”（必需） |
BackupPolicyMigrationState
| 名字 | 描述 | 价值 |
|---|---|---|
| startTime | 备份策略迁移开始的时间（ISO-8601 格式）。 | 字符串 |
| 地位 | 描述备份策略类型之间的迁移状态。 | “Completed” “Failed” “InProgress” “Invalid” |
| targetType | 描述备份策略迁移的目标备份策略类型。 | “continuous” “定期” |
能力
| 名字 | 描述 | 价值 |
|---|---|---|
| 名字 | Cosmos DB 功能的名称。 例如，“name”：“EnableCassandra”。 当前值还包括“EnableTable”和“EnableGremlin”。 | 字符串 |
能力
| 名字 | 描述 | 价值 |
|---|---|---|
| totalThroughputLimit | 对帐户施加的总吞吐量限制。 totalThroughputLimit 为 2000，对可以预配到 2000 的帐户的最大吞吐量施加严格限制。 -1 totalThroughputLimit 表示对预配吞吐量没有限制。 | int 约束： 最小值 = -1 |
Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties
| 名字 | 描述 | 价值 |
|---|
ConsistencyPolicy
| 名字 | 描述 | 价值 |
|---|---|---|
| defaultConsistencyLevel | Cosmos DB 帐户的默认一致性级别和配置设置。 | “BoundedStaleness” “ConsistentPrefix” “最终” “Session” “强”（必需） |
| maxIntervalInSeconds | 与有限过期一致性级别一起使用时，此值表示容忍的过期时间量（以秒为单位）。 此值的接受范围为 5 - 86400。 当 defaultConsistencyPolicy 设置为“BoundedStaleness”时必需。 | int 约束： 最小值 = 5 最大值 = 86400 |
| maxStalenessPrefix | 与有限过期一致性级别一起使用时，此值表示允许的过时请求数。 此值的接受范围为 1 – 2,147,483,647。 当 defaultConsistencyPolicy 设置为“BoundedStaleness”时必需。 | int 约束： 最小值 = 1 最大值 = 2147483647 |
ContinuousModeBackupPolicy
| 名字 | 描述 | 价值 |
|---|---|---|
| continuousModeProperties | 连续模式备份的配置值 | ContinuousModeProperties |
| 类型 | 描述备份模式。 | “连续”（必需） |
ContinuousModeProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| 层 | 枚举以指示连续备份模式的类型 | “Continuous30Days” “Continuous7Days” |
CorsPolicy
| 名字 | 描述 | 价值 |
|---|---|---|
| allowedHeaders | 源域可以在 CORS 请求上指定的请求标头。 | 字符串 |
| allowedMethods | 源域可用于 CORS 请求的方法（HTTP 请求谓词）。 | 字符串 |
| allowedOrigins | 允许通过 CORS 针对服务发出请求的源域。 | string （必需） |
| exposedHeaders | 响应标头，这些标头可能在响应 CORS 请求中发送，并由浏览器向请求颁发者公开。 | 字符串 |
| maxAgeInSeconds | 浏览器应缓存预检 OPTIONS 请求的最大时间。 | int 约束： 最小值 = 1 最大值 = 2147483647 |
DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| 分析StorageConfiguration | 分析存储特定属性。 | 分析StorageConfiguration |
| apiProperties | API 特定属性。 目前，仅 MongoDB API 支持。 | ApiProperties |
| backupPolicy | 表示用于在帐户上备份的策略的对象。 | BackupPolicy |
| 能力 | 帐户的 Cosmos DB 功能列表 | 功能[] |
| 能力 | 表示与帐户上的容量强制实施相关的所有属性的对象。 | 容量 |
| connectorOffer | cassandra 连接器为 Cosmos DB 数据库 C* 帐户提供类型。 | “Small” |
| consistencyPolicy | Cosmos DB 帐户的一致性策略。 | ConsistencyPolicy |
| cors | Cosmos DB 数据库帐户的 CORS 策略。 | CorsPolicy[] |
| createMode | 枚举以指示帐户创建模式。 | “Default” “还原” |
| customerManagedKeyStatus | 指示帐户上客户管理的密钥功能的状态。 如果出现错误，该属性将提供故障排除指南。 | 字符串 |
| databaseAccountOfferType | 数据库的套餐类型 | “标准”（必需） |
| defaultIdentity | 用于访问客户托管密钥等功能中使用的密钥保管库的默认标识。 用户需要显式设置默认标识。 它可以是“FirstPartyIdentity”、“SystemAssignedIdentity”等。 | 字符串 |
| disableKeyBasedMetadataWriteAccess | 通过帐户密钥对元数据资源（数据库、容器、吞吐量）禁用写入操作 | bool |
| disableLocalAuth | 选择退出本地身份验证，并确保只能将 MSI 和 AAD 用于身份验证。 | bool |
| enableAnalyticalStorage | 用于指示是否启用存储分析的标志。 | bool |
| enableAutomaticFailover | 在极少数情况下启用写入区域的自动故障转移，因为服务中断导致该区域不可用。 自动故障转移将导致帐户的新写入区域，并根据为帐户配置的故障转移优先级进行选择。 | bool |
| enableBurstCapacity | 指示在帐户上启用/禁用突发容量功能的标志 | bool |
| enableCassandraConnector | 在 Cosmos DB C* 帐户上启用 cassandra 连接器 | bool |
| enableFreeTier | 用于指示是否启用免费层的标志。 | bool |
| enableMultipleWriteLocations | 使帐户能够在多个位置写入 | bool |
| enablePartitionMerge | 用于指示在帐户上启用/禁用分区合并功能的标志 | bool |
| ipRules | IpRules 列表。 | IpAddressOrRange[] |
| isVirtualNetworkFilterEnabled | 用于指示是否启用/禁用虚拟网络 ACL 规则的标志。 | bool |
| keyVaultKeyUri | 密钥保管库的 URI | 字符串 |
| 地点 | 一个数组，其中包含为 Cosmos DB 帐户启用的地理复制位置。 | 位置[] （必需） |
| minimalTlsVersion | 指示允许的最低 Tls 版本。 默认值为 Tls 1.2。 Cassandra 和 Mongo API 仅适用于 Tls 1.2。 | “Tls” “Tls11” “Tls12” |
| networkAclBypass | 指示允许哪些服务绕过防火墙检查。 | “AzureServices” “None” |
| networkAclBypassResourceIds | 一个数组，其中包含 Cosmos DB 帐户的网络 Acl 绕过的资源 ID。 | string[] |
| publicNetworkAccess | 是否允许来自公用网络的请求 | “Disabled” “Enabled” “SecuredByPerimeter” |
| restoreParameters | 用于指示还原信息的参数。 | RestoreParameters |
| virtualNetworkRules | 为 Cosmos DB 帐户配置的虚拟网络 ACL 规则列表。 | VirtualNetworkRule[] |
DatabaseRestoreResource
| 名字 | 描述 | 价值 |
|---|---|---|
| collectionNames | 可用于还原的集合的名称。 | string[] |
| databaseName | 可用于还原的数据库的名称。 | 字符串 |
GremlinDatabaseRestoreResource
| 名字 | 描述 | 价值 |
|---|---|---|
| databaseName | 可用于还原的 gremlin 数据库的名称。 | 字符串 |
| graphNames | 可用于还原的图形的名称。 | string[] |
IpAddressOrRange
| 名字 | 描述 | 价值 |
|---|---|---|
| ipAddressOrRange | 单个 IPv4 地址或 CIDR 格式的单个 IPv4 地址范围。 提供的 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”包括隐式创建的标识和一组用户分配的标识。 类型“None”将从服务中删除任何标识。 | “None” “SystemAssigned” “SystemAssigned，UserAssigned” “UserAssigned” |
| userAssignedIdentities | 与资源关联的用户标识列表。 用户标识字典密钥引用的格式为 ARM 资源 ID：“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。 | ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
| 名字 | 描述 | 价值 |
|---|
Microsoft.DocumentDB/databaseAccounts
| 名字 | 描述 | 价值 |
|---|---|---|
| 身份 | 资源的标识。 | ManagedServiceIdentity |
| 类 | 指示数据库帐户的类型。 只能在创建数据库帐户时设置此设置。 | “GlobalDocumentDB” “MongoDB” “Parse” |
| 位置 | 资源所属的资源组的位置。 | 字符串 |
| 名字 | 资源名称 | 字符串 约束： 最小长度 = 3 最大长度 = 3 模式 = ^[a-z0-9]+(-[a-z0-9]+)* （必需） |
| 性能 | 用于创建和更新 Azure Cosmos DB 数据库帐户的属性。 | DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties （必需） |
| 标签 | 资源标记 | 标记名称和值的字典。 |
| 类型 | 资源类型 | “Microsoft.DocumentDB/databaseAccounts@2023-11-15” |
PeriodicModeBackupPolicy
| 名字 | 描述 | 价值 |
|---|---|---|
| periodicModeProperties | 定期模式备份的配置值 | PeriodicModeProperties |
| 类型 | 描述备份模式。 | “定期”（必需） |
PeriodicModeProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| backupIntervalInMinutes | 一个整数，表示两次备份之间的间隔（以分钟为单位） | int 约束： 最小值 = 0 |
| backupRetentionIntervalInHours | 一个整数，表示保留每个备份的时间（以小时为单位） | int 约束： 最小值 = 0 |
| backupStorageRedundancy | 用于指示备份驻留类型的枚举 | “Geo” “Local” “Zone” |
RestoreParameters
| 名字 | 描述 | 价值 |
|---|---|---|
| databasesToRestore | 可用于还原的特定数据库的列表。 | DatabaseRestoreResource[] |
| gremlinDatabasesToRestore | 可用于还原的特定 gremlin 数据库的列表。 | GremlinDatabaseRestoreResource[] |
| restoreMode | 描述还原模式。 | “PointInTime” |
| restoreSource | 必须从中启动还原的可还原数据库帐户的 ID。 例如：/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} | 字符串 |
| restoreTimestampInUtc | 帐户必须还原到的时间（ISO-8601 格式）。 | 字符串 |
| tablesToRestore | 可用于还原的特定表的列表。 | string[] |
标签
| 名字 | 描述 | 价值 |
|---|
VirtualNetworkRule
| 名字 | 描述 | 价值 |
|---|---|---|
| id | 子网的资源 ID，例如：/subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}。 | 字符串 |
| ignoreMissingVNetServiceEndpoint | 在虚拟网络启用 vnet 服务终结点之前创建防火墙规则。 | bool |