你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Microsoft.DocumentDB databaseAccounts 2021-04-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 年 3 月 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@2021-04-15' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  kind: 'string'
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  properties: {
    apiProperties: {
      serverVersion: 'string'
    }
    backupPolicy: {
      type: 'string'
      // For remaining properties, see BackupPolicy objects
    }
    capabilities: [
      {
        name: 'string'
      }
    ]
    connectorOffer: 'Small'
    consistencyPolicy: {
      defaultConsistencyLevel: 'string'
      maxIntervalInSeconds: int
      maxStalenessPrefix: int
    }
    cors: [
      {
        allowedHeaders: 'string'
        allowedMethods: 'string'
        allowedOrigins: 'string'
        exposedHeaders: 'string'
        maxAgeInSeconds: int
      }
    ]
    databaseAccountOfferType: 'Standard'
    defaultIdentity: 'string'
    disableKeyBasedMetadataWriteAccess: bool
    enableAnalyticalStorage: bool
    enableAutomaticFailover: bool
    enableCassandraConnector: bool
    enableFreeTier: bool
    enableMultipleWriteLocations: bool
    ipRules: [
      {
        ipAddressOrRange: 'string'
      }
    ]
    isVirtualNetworkFilterEnabled: bool
    keyVaultKeyUri: 'string'
    locations: [
      {
        failoverPriority: int
        isZoneRedundant: bool
        locationName: 'string'
      }
    ]
    networkAclBypass: 'string'
    networkAclBypassResourceIds: [
      'string'
    ]
    publicNetworkAccess: 'string'
    virtualNetworkRules: [
      {
        id: 'string'
        ignoreMissingVNetServiceEndpoint: bool
      }
    ]
  }
}

BackupPolicy 对象

设置 type 属性以指定对象的类型。

对于 “连续”，请使用：

  type: 'Continuous'

对于 定期，请使用：

  type: 'Periodic'
  periodicModeProperties: {
    backupIntervalInMinutes: int
    backupRetentionIntervalInHours: int
  }

属性值

databaseAccounts

名称	说明	值
name	资源名称	字符串 (必需) 字符限制：3-44 有效字符： 小写字母、数字和连字符。 以小写字母或数字开头。 资源名称在 Azure 中必须是唯一的。
location	资源所属的资源组的位置。	字符串
标记	标记是描述资源的键值对的列表。 在查看此资源和为此资源分组（跨资源组）时，可以使用这些标记。 最多可以为一个资源提供 15 个标记。 每个标记的键不能超过 128 个字符，值不能超过 256 个字符。 例如，模板类型的默认体验设置为“defaultExperience”：“Cassandra”。 当前的“defaultExperience”值还包括“Table”、“Graph”、“DocumentDB”和“MongoDB”。	标记名称和值的字典。 请参阅 模板中的标记
kind	指示数据库帐户的类型。 这只能在创建数据库帐户时进行设置。	“GlobalDocumentDB” “MongoDB” “Parse”
标识	资源的标识。	ManagedServiceIdentity
properties	用于创建和更新 Azure Cosmos DB 数据库帐户的属性。	DatabaseAccountCreateUpdatePropertiesOrDatabaseAccou... 所需的 ()

ManagedServiceIdentity

名称	说明	Value
type	用于资源的标识类型。 类型“SystemAssigned，UserAssigned”包括隐式创建的标识和一组用户分配的标识。 类型“None”将从服务中删除任何标识。	“None” “SystemAssigned” “SystemAssigned，UserAssigned” “UserAssigned”
userAssignedIdentities	与资源关联的用户标识列表。 用户标识字典密钥引用将是 ARM 资源 ID，格式为：“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。	ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

名称	说明	值
{customized property}		Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

此对象不包含在部署期间要设置的任何属性。 所有属性均为 ReadOnly。

DatabaseAccountCreateUpdatePropertiesOrDatabaseAccou...

名称	说明	值
apiProperties	API 特定的属性。 目前，仅 MongoDB API 支持。	ApiProperties
backupPolicy	表示在帐户上进行备份的策略的 对象。	BackupPolicy
capabilities	帐户的 Cosmos DB 功能列表	Capability[]
connectorOffer	Cassandra 连接器为 Cosmos DB 数据库 C* 帐户提供类型。	“Small”
consistencyPolicy	Cosmos DB 帐户的一致性策略。	ConsistencyPolicy
cors	Cosmos DB 数据库帐户的 CORS 策略。	CorsPolicy[]
databaseAccountOfferType	数据库的套餐类型	“标准” (必需)
defaultIdentity	用于访问客户托管密钥等功能中使用的密钥保管库的默认标识。 默认标识需要由用户显式设置。 它可以是“FirstPartyIdentity”、“SystemAssignedIdentity”等。	字符串
disableKeyBasedMetadataWriteAccess	通过帐户密钥对元数据资源 (数据库、容器、吞吐量) 禁用写入操作	bool
enableAnalyticalStorage	指示是否启用存储分析的标志。	bool
enableAutomaticFailover	在极少数情况下，如果写入区域因中断而不可用，则启用写入区域的自动故障转移。 自动故障转移将导致帐户的新写入区域，并根据为帐户配置的故障转移优先级进行选择。	bool
enableCassandraConnector	在 Cosmos DB C* 帐户上启用 cassandra 连接器	bool
enableFreeTier	指示是否启用免费层的标志。	bool
enableMultipleWriteLocations	使帐户能够在多个位置进行写入	bool
ipRules	IpRules 列表。	IpAddressOrRange[]
isVirtualNetworkFilterEnabled	指示是否启用/禁用虚拟网络 ACL 规则的标志。	bool
keyVaultKeyUri	密钥保管库的 URI	字符串
locations	一个数组，其中包含为 Cosmos DB 帐户启用的地理复制位置。	location[] (必需)
networkAclBypass	指示允许哪些服务绕过防火墙检查。	“AzureServices” “None”
networkAclBypassResourceIds	一个数组，其中包含 Cosmos DB 帐户的网络 Acl 旁路的资源 ID。	string[]
publicNetworkAccess	是否允许来自公用网络的请求	“Disabled” “已启用”
virtualNetworkRules	为 Cosmos DB 帐户配置的虚拟网络 ACL 规则列表。	VirtualNetworkRule[]

ApiProperties

名称	说明	值
serverVersion	描述 MongoDB 帐户的 ServerVersion。	'3.2' '3.6' '4.0'

BackupPolicy

名称	说明	Value
type	设置对象类型	连续 需要定期 ()

ContinuousModeBackupPolicy

名称	说明	Value
type	描述备份模式。	“连续” (必需)

PeriodicModeBackupPolicy

名称	说明	Value
type	描述备份模式。	“定期” (必需)
periodicModeProperties	定期模式备份的配置值	PeriodicModeProperties

PeriodicModeProperties

名称	说明	值
backupIntervalInMinutes	一个整数，表示两次备份之间的间隔（以分钟为单位）	int 约束： 最小值 = 0
backupRetentionIntervalInHours	一个整数，表示保留每个备份) (的时间（以小时为单位）	int 约束： 最小值 = 0

功能

名称	说明	值
name	Cosmos DB 功能的名称。 例如，“name”：“EnableCassandra”。 当前值还包括“EnableTable”和“EnableGremlin”。	字符串

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

CorsPolicy

名称	说明	值
allowedHeaders	源域可以在 CORS 请求上指定的请求标头。	字符串
allowedMethods	源域可用于 CORS 请求的方法（HTTP 请求谓词）。	字符串
allowedOrigins	允许通过 CORS 对服务发出请求的源域。	字符串 (必需)
exposedHeaders	可以在 CORS 请求响应中发送并由浏览器向请求发出方公开的响应标头。	字符串
maxAgeInSeconds	浏览器应缓存预检 OPTIONS 请求的最长时间。	int 约束： 最小值 = 1 最大值 = 2147483647

IpAddressOrRange

名称	说明	值
ipAddressOrRange	CIDR 格式的单个 IPv4 地址或单个 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”。	string

位置

名称	说明	值
failoverPriority	区域的故障转移优先级。 故障转移优先级为 0 表示写入区域。 故障转移优先级的最大值 = (总区域数 - 1) 。 对于数据库帐户所在的每个区域，故障转移优先级值必须是唯一的。	int 约束： 最小值 = 0
isZoneRedundant	指示此区域是否为 AvailabilityZone 区域的标志	bool
locationName	区域的名称。	字符串

VirtualNetworkRule

名称	说明	Value
id	子网的资源 ID，例如：/subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}。	字符串
ignoreMissingVNetServiceEndpoint	在虚拟网络启用 vnet 服务终结点之前创建防火墙规则。	bool

快速入门模板

以下快速入门模板部署此资源类型。

模板	说明
在 Azure 容器服务上使用 Jenkins 的 CI/CD (AKS)	容器使你可以轻松地持续生成和部署应用程序。 通过在 Azure 容器服务中使用 Kubernetes 协调这些容器的部署，可以实现可复制、可管理的容器群集。 通过设置持续生成来生成容器映像和业务流程，可以提高部署的速度和可靠性。
包含 SQL 数据库的 Web 应用、Azure Cosmos DB、Azure 搜索	此模板预配 Web 应用、SQL 数据库、Azure Cosmos DB、Azure 搜索和 Application Insights。
为 Cassandra API 创建 Azure Cosmos DB 帐户	此模板在具有密钥空间和具有专用吞吐量的表的两个区域中为 Cassandra API 创建 Azure Cosmos DB 帐户。
为 Cassandra API 创建自动缩放 Azure Cosmos DB 帐户	此模板在两个区域中为 Cassandra API 创建 Azure Cosmos DB 帐户，其中包含密钥空间和具有自动缩放吞吐量的表。
创建 Azure CosmosDB 帐户	此 ARM 模板旨在使用所需的最小值快速创建 CosmosDB 帐户
在多个区域中创建 Azure Cosmos DB 帐户	此模板为具有主区域和次要区域的任何数据库 API 类型创建 Azure Cosmos DB 帐户，可以选择一致性级别和故障转移类型。
创建免费层 Azure Cosmos DB 帐户	此模板为 SQL API 创建一个免费层 Azure Cosmos DB 帐户，其中包含具有共享吞吐量和容器的数据库。
为 Gremlin API 创建 Azure Cosmos DB 帐户	此模板在两个区域中为 Gremlin API 创建 Azure Cosmos DB 帐户，其中包含一个数据库和一个使用专用吞吐量的图形。
为 Gremlin API 自动缩放创建 Azure Cosmos DB 帐户	此模板在两个区域中为 Gremlin API 创建 Azure Cosmos DB 帐户，其中包含一个数据库和一个使用自动缩放吞吐量的图形。
为 MongoDB API 创建 Azure Cosmos 帐户	此模板使用具有两个集合的共享吞吐量和专用吞吐量在两个区域中为 MongoDB API 4.2 创建 Azure Cosmos DB 帐户。
为 MongoDB API 自动缩放创建 Azure Cosmos 帐户	此模板使用共享和专用自动缩放吞吐量在两个区域中为 MongoDB API 4.2 创建 Azure Cosmos DB 帐户。
使用专用终结点创建 Azure Cosmos DB 帐户	此模板将创建一个 Cosmos 帐户、一个虚拟网络和一个向虚拟网络公开 Cosmos 帐户的专用终结点。
为 Core (SQL) API 创建 Azure Cosmos DB 帐户	此模板为 Core (SQL) API 创建 Azure Cosmos 帐户，其中包含数据库和具有多个其他选项的吞吐量容器。
具有分析存储的 Azure Cosmos DB 帐户 SQL API	此模板为 Core (SQL) API 创建 Azure Cosmos 帐户，其中包含配置了分析存储的数据库和容器。
使用自动缩放创建 Azure Cosmos DB 帐户 SQL API	此模板为 Core (SQL) API 创建 Azure Cosmos 帐户，其中包含具有自动缩放吞吐量的数据库和容器以及多个其他选项。
创建 Azure Cosmos DB Core (SQL) API 存储过程	此模板为 Core (SQL) API 创建 Azure Cosmos DB 帐户，并使用存储过程、触发器和用户定义的函数创建容器。
为 Core (SQL) API 创建最少的 Azure Cosmos DB 帐户	此模板为 Core (SQL) API 创建 Azure Cosmos DB 帐户，同时仅指定所需的最低资源属性。
使用 SQL API 和多个容器创建 Azure Cosmos	该模板使用 SQL API 创建 Cosmos 容器，并允许添加多个容器。
使用数据平面 RBAC 创建 Azure Cosmos DB SQL 帐户	此模板将创建一个 SQL Cosmos 帐户、一个本机维护的角色定义以及一个为 AAD 标识提供的本机维护角色分配。
为 SQL API 创建无服务器 Azure Cosmos DB 帐户	此模板为 Core (SQL) API 创建无服务器 Azure Cosmos DB 帐户。
为表 API 创建 Azure Cosmos 帐户	此模板在两个区域中为表 API 创建 Azure Cosmos DB 帐户，以及一个具有预配吞吐量的表。
使用自动缩放为表 API 创建 Azure Cosmos 帐户	此模板在两个区域中为表 API 创建 Azure Cosmos DB 帐户，以及一个具有自动缩放吞吐量的表。
创建零接触 Azure Cosmos 帐户和 Azure Web 应用	此模板创建 Azure Cosmos 帐户，将 Cosmos DB 终结点和密钥注入 Azure Web 应用设置，然后从 GitHub 部署 ASP MVC Web 应用。
创建启用了 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 可检测潜在的 SQL 注入、基于 Microsoft 威胁情报的已知不良参与者、可疑访问模式，以及通过泄露的标识或恶意内部人员对数据库的潜在利用。
使用 Cosmos DB 连接部署 Azure 数据资源管理器 DB	使用 Cosmos DB 连接部署 Azure 数据资源管理器 DB。
使用 Web 应用的 Azure Cosmos DB 帐户	此模板部署 Azure Cosmos DB 帐户、应用服务计划，并在应用服务计划中创建 Web 应用。 它还将两个应用程序设置添加到引用 Azure Cosmos DB 帐户终结点的 Web 应用。 这样，部署到 Web 应用的解决方案就可以使用这些设置连接到 Azure Cosmos DB 帐户终结点。

ARM 模板资源定义

databaseAccounts 资源类型可以使用目标操作进行部署：

• 资源组 - 请参阅 资源组部署命令

有关每个 API 版本中更改的属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.DocumentDB/databaseAccounts 资源，请将以下 JSON 添加到模板。

{
  "type": "Microsoft.DocumentDB/databaseAccounts",
  "apiVersion": "2021-04-15",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "kind": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {}
    }
  },
  "properties": {
    "apiProperties": {
      "serverVersion": "string"
    },
    "backupPolicy": {
      "type": "string"
      // For remaining properties, see BackupPolicy objects
    },
    "capabilities": [
      {
        "name": "string"
      }
    ],
    "connectorOffer": "Small",
    "consistencyPolicy": {
      "defaultConsistencyLevel": "string",
      "maxIntervalInSeconds": "int",
      "maxStalenessPrefix": "int"
    },
    "cors": [
      {
        "allowedHeaders": "string",
        "allowedMethods": "string",
        "allowedOrigins": "string",
        "exposedHeaders": "string",
        "maxAgeInSeconds": "int"
      }
    ],
    "databaseAccountOfferType": "Standard",
    "defaultIdentity": "string",
    "disableKeyBasedMetadataWriteAccess": "bool",
    "enableAnalyticalStorage": "bool",
    "enableAutomaticFailover": "bool",
    "enableCassandraConnector": "bool",
    "enableFreeTier": "bool",
    "enableMultipleWriteLocations": "bool",
    "ipRules": [
      {
        "ipAddressOrRange": "string"
      }
    ],
    "isVirtualNetworkFilterEnabled": "bool",
    "keyVaultKeyUri": "string",
    "locations": [
      {
        "failoverPriority": "int",
        "isZoneRedundant": "bool",
        "locationName": "string"
      }
    ],
    "networkAclBypass": "string",
    "networkAclBypassResourceIds": [ "string" ],
    "publicNetworkAccess": "string",
    "virtualNetworkRules": [
      {
        "id": "string",
        "ignoreMissingVNetServiceEndpoint": "bool"
      }
    ]
  }
}

BackupPolicy 对象

设置 type 属性以指定对象的类型。

对于 “连续”，请使用：

  "type": "Continuous"

对于 定期，请使用：

  "type": "Periodic",
  "periodicModeProperties": {
    "backupIntervalInMinutes": "int",
    "backupRetentionIntervalInHours": "int"
  }

属性值

databaseAccounts

名称	说明	Value
type	资源类型	“Microsoft.DocumentDB/databaseAccounts”
apiVersion	资源 API 版本	'2021-04-15'
name	资源名称	字符串 (必需) 字符限制：3-44 有效字符： 小写字母、数字和连字符。 以小写字母或数字开头。 资源名称在 Azure 中必须是唯一的。
location	资源所属的资源组的位置。	字符串
标记	标记是描述资源的键值对的列表。 在查看此资源和为此资源分组（跨资源组）时，可以使用这些标记。 最多可以为一个资源提供 15 个标记。 每个标记的键不能超过 128 个字符，值不能超过 256 个字符。 例如，模板类型的默认体验设置为“defaultExperience”：“Cassandra”。 当前的“defaultExperience”值还包括“Table”、“Graph”、“DocumentDB”和“MongoDB”。	标记名称和值的字典。 请参阅 模板中的标记
kind	指示数据库帐户的类型。 这只能在创建数据库帐户时进行设置。	“GlobalDocumentDB” “MongoDB” “Parse”
标识	资源的标识。	ManagedServiceIdentity
properties	用于创建和更新 Azure Cosmos DB 数据库帐户的属性。	DatabaseAccountCreateUpdatePropertiesOrDatabaseAccou... 所需的 ()

ManagedServiceIdentity

名称	说明	Value
type	用于资源的标识类型。 类型“SystemAssigned，UserAssigned”包括隐式创建的标识和一组用户分配的标识。 类型“None”将从服务中删除任何标识。	“None” “SystemAssigned” “SystemAssigned，UserAssigned” “UserAssigned”
userAssignedIdentities	与资源关联的用户标识列表。 用户标识字典密钥引用将是 ARM 资源 ID，格式为：“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。	ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

名称	说明	值
{customized property}		Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

此对象不包含在部署期间要设置的任何属性。 所有属性均为 ReadOnly。

DatabaseAccountCreateUpdatePropertiesOrDatabaseAccou...

名称	说明	值
apiProperties	API 特定的属性。 目前，仅 MongoDB API 支持。	ApiProperties
backupPolicy	表示在帐户上进行备份的策略的 对象。	BackupPolicy
capabilities	帐户的 Cosmos DB 功能列表	Capability[]
connectorOffer	Cassandra 连接器为 Cosmos DB 数据库 C* 帐户提供类型。	“Small”
consistencyPolicy	Cosmos DB 帐户的一致性策略。	ConsistencyPolicy
cors	Cosmos DB 数据库帐户的 CORS 策略。	CorsPolicy[]
databaseAccountOfferType	数据库的套餐类型	“标准” (必需)
defaultIdentity	用于访问客户托管密钥等功能中使用的密钥保管库的默认标识。 默认标识需要由用户显式设置。 它可以是“FirstPartyIdentity”、“SystemAssignedIdentity”等。	字符串
disableKeyBasedMetadataWriteAccess	通过帐户密钥对元数据资源 (数据库、容器、吞吐量) 禁用写入操作	bool
enableAnalyticalStorage	指示是否启用存储分析的标志。	bool
enableAutomaticFailover	在极少数情况下，如果写入区域因中断而不可用，则启用写入区域的自动故障转移。 自动故障转移将导致帐户的新写入区域，并根据为帐户配置的故障转移优先级进行选择。	bool
enableCassandraConnector	在 Cosmos DB C* 帐户上启用 cassandra 连接器	bool
enableFreeTier	指示是否启用免费层的标志。	bool
enableMultipleWriteLocations	使帐户能够在多个位置进行写入	bool
ipRules	IpRules 列表。	IpAddressOrRange[]
isVirtualNetworkFilterEnabled	指示是否启用/禁用虚拟网络 ACL 规则的标志。	bool
keyVaultKeyUri	密钥保管库的 URI	字符串
locations	一个数组，其中包含为 Cosmos DB 帐户启用的地理复制位置。	location[] (必需)
networkAclBypass	指示允许哪些服务绕过防火墙检查。	“AzureServices” “None”
networkAclBypassResourceIds	一个数组，其中包含 Cosmos DB 帐户的网络 Acl 旁路的资源 ID。	string[]
publicNetworkAccess	是否允许来自公用网络的请求	“Disabled” “已启用”
virtualNetworkRules	为 Cosmos DB 帐户配置的虚拟网络 ACL 规则列表。	VirtualNetworkRule[]

ApiProperties

名称	说明	值
serverVersion	描述 MongoDB 帐户的 ServerVersion。	'3.2' '3.6' '4.0'

BackupPolicy

名称	说明	Value
type	设置对象类型	连续 需要定期 ()

ContinuousModeBackupPolicy

名称	说明	Value
type	描述备份模式。	需要“连续” ()

PeriodicModeBackupPolicy

名称	说明	Value
type	描述备份模式。	“定期” (必需)
periodicModeProperties	定期模式备份的配置值	PeriodicModeProperties

PeriodicModeProperties

名称	说明	值
backupIntervalInMinutes	一个整数，表示两次备份之间的间隔（以分钟为单位）	int 约束： 最小值 = 0
backupRetentionIntervalInHours	一个整数，表示保留每个备份) (的时间（以小时为单位）	int 约束： 最小值 = 0

功能

名称	说明	值
name	Cosmos DB 功能的名称。 例如，“name”：“EnableCassandra”。 当前值还包括“EnableTable”和“EnableGremlin”。	字符串

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

CorsPolicy

名称	说明	值
allowedHeaders	源域可以在 CORS 请求上指定的请求标头。	字符串
allowedMethods	源域可用于 CORS 请求的方法（HTTP 请求谓词）。	字符串
allowedOrigins	允许通过 CORS 对服务发出请求的源域。	字符串 (必需)
exposedHeaders	可以在 CORS 请求响应中发送并由浏览器向请求发出方公开的响应标头。	字符串
maxAgeInSeconds	浏览器应缓存预检 OPTIONS 请求的最长时间。	int 约束： 最小值 = 1 最大值 = 2147483647

IpAddressOrRange

名称	说明	值
ipAddressOrRange	CIDR 格式的单个 IPv4 地址或单个 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”。	string

位置

名称	说明	值
failoverPriority	区域的故障转移优先级。 故障转移优先级为 0 表示写入区域。 故障转移优先级的最大值 = (总区域数 - 1) 。 对于数据库帐户所在的每个区域，故障转移优先级值必须是唯一的。	int 约束： 最小值 = 0
isZoneRedundant	指示此区域是否为 AvailabilityZone 区域的标志	bool
locationName	区域的名称。	字符串

VirtualNetworkRule

名称	说明	Value
id	子网的资源 ID，例如：/subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}。	字符串
ignoreMissingVNetServiceEndpoint	在虚拟网络启用 vnet 服务终结点之前创建防火墙规则。	bool

快速入门模板

以下快速入门模板部署此资源类型。

模板	说明
在 Azure 容器服务上使用 Jenkins 的 CI/CD (AKS)	容器使你可以轻松地持续生成和部署应用程序。 通过在 Azure 容器服务中使用 Kubernetes 协调这些容器的部署，可以实现可复制、可管理的容器群集。 通过设置持续生成来生成容器映像和业务流程，可以提高部署的速度和可靠性。
包含 SQL 数据库的 Web 应用、Azure Cosmos DB、Azure 搜索	此模板预配 Web 应用、SQL 数据库、Azure Cosmos DB、Azure 搜索和 Application Insights。
为 Cassandra API 创建 Azure Cosmos DB 帐户	此模板在具有密钥空间和具有专用吞吐量的表的两个区域中为 Cassandra API 创建 Azure Cosmos DB 帐户。
为 Cassandra API 创建自动缩放 Azure Cosmos DB 帐户	此模板在两个区域中为 Cassandra API 创建 Azure Cosmos DB 帐户，其中包含密钥空间和具有自动缩放吞吐量的表。
创建 Azure CosmosDB 帐户	此 ARM 模板旨在使用所需的最小值快速创建 CosmosDB 帐户
在多个区域中创建 Azure Cosmos DB 帐户	此模板为具有主区域和次要区域的任何数据库 API 类型创建 Azure Cosmos DB 帐户，可以选择一致性级别和故障转移类型。
创建免费层 Azure Cosmos DB 帐户	此模板为 SQL API 创建一个免费层 Azure Cosmos DB 帐户，其中包含具有共享吞吐量和容器的数据库。
为 Gremlin API 创建 Azure Cosmos DB 帐户	此模板在两个区域中为 Gremlin API 创建 Azure Cosmos DB 帐户，其中包含一个数据库和一个使用专用吞吐量的图形。
为 Gremlin API 自动缩放创建 Azure Cosmos DB 帐户	此模板在两个区域中为 Gremlin API 创建 Azure Cosmos DB 帐户，其中包含一个数据库和一个使用自动缩放吞吐量的图形。
为 MongoDB API 创建 Azure Cosmos 帐户	此模板使用具有两个集合的共享吞吐量和专用吞吐量在两个区域中为 MongoDB API 4.2 创建 Azure Cosmos DB 帐户。
为 MongoDB API 自动缩放创建 Azure Cosmos 帐户	此模板使用共享和专用自动缩放吞吐量在两个区域中为 MongoDB API 4.2 创建 Azure Cosmos DB 帐户。
使用专用终结点创建 Azure Cosmos DB 帐户	此模板将创建一个 Cosmos 帐户、一个虚拟网络和一个向虚拟网络公开 Cosmos 帐户的专用终结点。
为 Core (SQL) API 创建 Azure Cosmos DB 帐户	此模板为 Core (SQL) API 创建 Azure Cosmos 帐户，其中包含数据库和具有多个其他选项的吞吐量容器。
具有分析存储的 Azure Cosmos DB 帐户 SQL API	此模板为 Core (SQL) API 创建 Azure Cosmos 帐户，其中包含配置了分析存储的数据库和容器。
使用自动缩放创建 Azure Cosmos DB 帐户 SQL API	此模板为 Core (SQL) API 创建 Azure Cosmos 帐户，其中包含具有自动缩放吞吐量的数据库和容器以及多个其他选项。
创建 Azure Cosmos DB Core (SQL) API 存储过程	此模板为 Core (SQL) API 创建 Azure Cosmos DB 帐户，并使用存储过程、触发器和用户定义的函数创建容器。
为 Core (SQL) API 创建最少的 Azure Cosmos DB 帐户	此模板为 Core (SQL) API 创建 Azure Cosmos DB 帐户，同时仅指定所需的最低资源属性。
使用 SQL API 和多个容器创建 Azure Cosmos	该模板使用 SQL API 创建 Cosmos 容器，并允许添加多个容器。
使用数据平面 RBAC 创建 Azure Cosmos DB SQL 帐户	此模板将创建一个 SQL Cosmos 帐户、一个本机维护的角色定义以及一个为 AAD 标识提供的本机维护角色分配。
为 SQL API 创建无服务器 Azure Cosmos DB 帐户	此模板为 Core (SQL) API 创建无服务器 Azure Cosmos DB 帐户。
为表 API 创建 Azure Cosmos 帐户	此模板在两个区域中为表 API 创建 Azure Cosmos DB 帐户，以及一个具有预配吞吐量的表。
使用自动缩放为表 API 创建 Azure Cosmos 帐户	此模板在两个区域中为表 API 创建 Azure Cosmos DB 帐户，以及一个具有自动缩放吞吐量的表。
创建零接触 Azure Cosmos 帐户和 Azure Web 应用	此模板创建 Azure Cosmos 帐户，将 Cosmos DB 终结点和密钥注入 Azure Web 应用设置，然后从 GitHub 部署 ASP MVC Web 应用。
创建启用了 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 可检测潜在的 SQL 注入、基于 Microsoft 威胁情报的已知不良参与者、可疑访问模式，以及通过泄露的标识或恶意内部人员对数据库的潜在利用。
使用 Cosmos DB 连接部署 Azure 数据资源管理器 DB	使用 Cosmos DB 连接部署 Azure 数据资源管理器 DB。
使用 Web 应用的 Azure Cosmos DB 帐户	此模板部署 Azure Cosmos DB 帐户、应用服务计划，并在应用服务计划中创建 Web 应用。 它还将两个应用程序设置添加到引用 Azure Cosmos DB 帐户终结点的 Web 应用。 这样，部署到 Web 应用的解决方案就可以使用这些设置连接到 Azure Cosmos DB 帐户终结点。

Terraform (AzAPI 提供程序) 资源定义

可以使用面向以下操作部署 databaseAccounts 资源类型：

• 资源组

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.DocumentDB/databaseAccounts 资源，请将以下 Terraform 添加到模板。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts@2021-04-15"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "string"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      apiProperties = {
        serverVersion = "string"
      }
      backupPolicy = {
        type = "string"
        // For remaining properties, see BackupPolicy objects
      }
      capabilities = [
        {
          name = "string"
        }
      ]
      connectorOffer = "Small"
      consistencyPolicy = {
        defaultConsistencyLevel = "string"
        maxIntervalInSeconds = int
        maxStalenessPrefix = int
      }
      cors = [
        {
          allowedHeaders = "string"
          allowedMethods = "string"
          allowedOrigins = "string"
          exposedHeaders = "string"
          maxAgeInSeconds = int
        }
      ]
      databaseAccountOfferType = "Standard"
      defaultIdentity = "string"
      disableKeyBasedMetadataWriteAccess = bool
      enableAnalyticalStorage = bool
      enableAutomaticFailover = bool
      enableCassandraConnector = bool
      enableFreeTier = bool
      enableMultipleWriteLocations = bool
      ipRules = [
        {
          ipAddressOrRange = "string"
        }
      ]
      isVirtualNetworkFilterEnabled = bool
      keyVaultKeyUri = "string"
      locations = [
        {
          failoverPriority = int
          isZoneRedundant = bool
          locationName = "string"
        }
      ]
      networkAclBypass = "string"
      networkAclBypassResourceIds = [
        "string"
      ]
      publicNetworkAccess = "string"
      virtualNetworkRules = [
        {
          id = "string"
          ignoreMissingVNetServiceEndpoint = bool
        }
      ]
    }
    kind = "string"
  })
}

BackupPolicy 对象

设置 type 属性以指定对象的类型。

对于 “连续”，请使用：

  type = "Continuous"

对于 定期，请使用：

  type = "Periodic"
  periodicModeProperties = {
    backupIntervalInMinutes = int
    backupRetentionIntervalInHours = int
  }

属性值

databaseAccounts

名称	说明	Value
type	资源类型	“Microsoft.DocumentDB/databaseAccounts@2021-04-15”
name	资源名称	字符串 (必需) 字符限制：3-44 有效字符： 小写字母、数字和连字符。 以小写字母或数字开头。 资源名称在 Azure 中必须是唯一的。
location	资源所属的资源组的位置。	字符串
parent_id	若要部署到资源组，请使用该资源组的 ID。	字符串 (必需)
标记	标记是描述资源的键值对的列表。 在查看此资源和为此资源分组（跨资源组）时，可以使用这些标记。 最多可以为资源提供 15 个标记。 每个标记的键不能超过 128 个字符，值不能超过 256 个字符。 例如，模板类型的默认体验设置为“defaultExperience”：“Cassandra”。 当前的“defaultExperience”值还包括“Table”、“Graph”、“DocumentDB”和“MongoDB”。	标记名称和值的字典。
kind	指示数据库帐户的类型。 这只能在创建数据库帐户时设置。	“GlobalDocumentDB” “MongoDB” “Parse”
标识	资源的标识。	ManagedServiceIdentity
properties	用于创建和更新 Azure Cosmos DB 数据库帐户的属性。	DatabaseAccountCreateUpdatePropertiesOrDatabaseAccou... 所需的 ()

ManagedServiceIdentity

名称	说明	Value
type	用于资源的标识类型。 类型“SystemAssigned，UserAssigned”包括隐式创建的标识和一组用户分配的标识。 类型“None”将从服务中删除任何标识。	“SystemAssigned” “SystemAssigned，UserAssigned” “UserAssigned”
identity_ids	与资源关联的用户标识列表。 用户标识字典键引用将是 ARM 资源 ID，格式为：“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。	用户标识 ID 的数组。

ManagedServiceIdentityUserAssignedIdentities

名称	说明	值
{customized property}		Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

此对象不包含部署期间要设置的任何属性。 所有属性均为 ReadOnly。

DatabaseAccountCreateUpdatePropertiesOrDatabaseAccou...

名称	说明	值
apiProperties	API 特定的属性。 目前，仅 MongoDB API 支持。	ApiProperties
backupPolicy	表示对帐户进行备份的策略的 对象。	BackupPolicy
capabilities	帐户的 Cosmos DB 功能列表	Capability[]
connectorOffer	Cassandra 连接器为 Cosmos DB 数据库 C* 帐户提供类型。	“Small”
consistencyPolicy	Cosmos DB 帐户的一致性策略。	ConsistencyPolicy
cors	Cosmos DB 数据库帐户的 CORS 策略。	CorsPolicy[]
databaseAccountOfferType	数据库的套餐类型	“标准” (必需)
defaultIdentity	用于访问客户托管密钥等功能中使用的密钥保管库的默认标识。 默认标识需要由用户显式设置。 它可以是“FirstPartyIdentity”、“SystemAssignedIdentity”等。	字符串
disableKeyBasedMetadataWriteAccess	通过帐户密钥对元数据资源 (数据库、容器、吞吐量) 禁用写入操作	bool
enableAnalyticalStorage	指示是否启用存储分析的标志。	bool
enableAutomaticFailover	在极少数情况下，如果写入区域因中断而不可用，则启用写入区域的自动故障转移。 自动故障转移将导致帐户的新写入区域，并根据为帐户配置的故障转移优先级进行选择。	bool
enableCassandraConnector	在 Cosmos DB C* 帐户上启用 cassandra 连接器	bool
enableFreeTier	指示是否启用免费层的标志。	bool
enableMultipleWriteLocations	使帐户能够在多个位置进行写入	bool
ipRules	IpRules 列表。	IpAddressOrRange[]
isVirtualNetworkFilterEnabled	指示是否启用/禁用虚拟网络 ACL 规则的标志。	bool
keyVaultKeyUri	密钥保管库的 URI	字符串
locations	一个数组，其中包含为 Cosmos DB 帐户启用的地理复制位置。	location[] (必需)
networkAclBypass	指示允许哪些服务绕过防火墙检查。	“AzureServices” "None"
networkAclBypassResourceIds	一个数组，其中包含 Cosmos DB 帐户的网络 Acl 旁路的资源 ID。	string[]
publicNetworkAccess	是否允许来自公用网络的请求	“Disabled” “已启用”
virtualNetworkRules	为 Cosmos DB 帐户配置的虚拟网络 ACL 规则列表。	VirtualNetworkRule[]

ApiProperties

名称	说明	值
serverVersion	描述 MongoDB 帐户的 ServerVersion。	"3.2" "3.6" "4.0"

BackupPolicy

名称	说明	Value
type	设置对象类型	连续 需要定期 ()

ContinuousModeBackupPolicy

名称	说明	Value
type	描述备份模式。	需要“连续” ()

PeriodicModeBackupPolicy

名称	说明	Value
type	描述备份模式。	需要“定期” ()
periodicModeProperties	定期模式备份的配置值	PeriodicModeProperties

PeriodicModeProperties

名称	说明	值
backupIntervalInMinutes	一个整数，表示两次备份之间的间隔（以分钟为单位）	int 约束： 最小值 = 0
backupRetentionIntervalInHours	一个整数，表示保留每个备份) (的时间（以小时为单位）	int 约束： 最小值 = 0

功能

名称	说明	值
name	Cosmos DB 功能的名称。 例如，“name”：“EnableCassandra”。 当前值还包括“EnableTable”和“EnableGremlin”。	字符串

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

CorsPolicy

名称	说明	值
allowedHeaders	源域可以在 CORS 请求上指定的请求标头。	字符串
allowedMethods	源域可用于 CORS 请求的方法（HTTP 请求谓词）。	字符串
allowedOrigins	允许通过 CORS 对服务发出请求的源域。	字符串 (必需)
exposedHeaders	可以在 CORS 请求响应中发送并由浏览器向请求发出方公开的响应标头。	字符串
maxAgeInSeconds	浏览器应缓存预检 OPTIONS 请求的最长时间。	int 约束： 最小值 = 1 最大值 = 2147483647

IpAddressOrRange

名称	说明	值
ipAddressOrRange	CIDR 格式的单个 IPv4 地址或单个 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”。	string

位置

名称	说明	值
failoverPriority	区域的故障转移优先级。 故障转移优先级为 0 表示写入区域。 故障转移优先级的最大值 = (区域总数 - 1) 。 对于数据库帐户所在的每个区域，故障转移优先级值必须是唯一的。	int 约束： 最小值 = 0
isZoneRedundant	指示此区域是否为 AvailabilityZone 区域的标志	bool
locationName	区域的名称。	字符串

VirtualNetworkRule

名称	说明	Value
id	子网的资源 ID，例如：/subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}。	字符串
ignoreMissingVNetServiceEndpoint	在虚拟网络启用 vnet 服务终结点之前创建防火墙规则。	bool