你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn 。
Microsoft.DocumentDB databaseAccounts/mongodbDatabases/collections
本文内容
Bicep 资源定义
可以使用目标操作部署 databaseAccounts/mongodbDatabases/collections 资源类型：
有关每个 API 版本中已更改属性的列表，请参阅 更改日志 。
若要创建 Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections 资源，请将以下 Bicep 添加到模板。
resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2024-12-01-preview' = {
parent: resourceSymbolicName
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
location: 'string'
name: 'string'
properties: {
options: {
autoscaleSettings: {
maxThroughput: int
}
throughput: int
}
resource: {
analyticalStorageTtl: int
createMode: 'string'
id: 'string'
indexes: [
{
key: {
keys: [
'string'
]
}
options: {
expireAfterSeconds: int
unique: bool
}
}
]
restoreParameters: {
restoreSource: 'string'
restoreTimestampInUtc: 'string'
restoreWithTtlDisabled: bool
}
shardKey: {
{customized property}: 'string'
}
}
}
tags: {
{customized property}: 'string'
}
}
属性值
AutoscaleSettings
名字
描述
价值
maxThroughput
表示最大吞吐量，资源可以纵向扩展。
int
Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties
CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions
名字
描述
价值
autoscaleSettings
指定自动缩放设置。 注意：需要吞吐量或自动缩放设置，但不需要两者。
AutoscaleSettings
吞吐量
每秒请求单位数。 例如，“throughput”：10000。
int
ManagedServiceIdentity
名字
描述
价值
类型
用于资源的标识类型。 类型“SystemAssigned，UserAssigned”包括隐式创建的标识和一组用户分配的标识。 类型“None”将从服务中删除任何标识。
“None”
userAssignedIdentities
与资源关联的用户标识列表。 用户标识字典密钥引用的格式为 ARM 资源 ID：“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。
ManagedServiceIdentityUserAssignedIdentities
ManagedServiceIdentityUserAssignedIdentities
Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections
MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties
MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource
名字
描述
价值
分析StorageTtl
分析 TTL。
int
createMode
用于指示资源创建模式的枚举。
“Default”
id
Cosmos DB MongoDB 集合的名称
string （必需）
指标
索引键列表
MongoIndex []
restoreParameters
指示有关还原的信息的参数
ResourceRestoreParameters
shardKey
要为请求应用的分片键的键值对。
ShardKeys
MongoIndex
MongoIndexKeys
名字
描述
价值
钥匙
Azure Cosmos DB 服务中每个 MongoDB 集合的密钥列表
string[]
MongoIndexOptions
名字
描述
价值
expireAfterSeconds
秒后过期
int
独特
唯一或不唯一
bool
ResourceRestoreParameters
名字
描述
价值
restoreSource
必须从中启动还原的可还原数据库帐户的 ID。 例如：/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}
字符串
restoreTimestampInUtc
帐户必须还原到的时间（ISO-8601 格式）。
字符串
restoreWithTtlDisabled
指定还原的帐户是否在成功还原时禁用时间To-Live。
bool
ShardKeys
快速入门示例
以下快速入门示例部署此资源类型。
ARM 模板资源定义
可以使用目标操作部署 databaseAccounts/mongodbDatabases/collections 资源类型：
有关每个 API 版本中已更改属性的列表，请参阅 更改日志 。
若要创建 Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections 资源，请将以下 JSON 添加到模板。
{
"type": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections",
"apiVersion": "2024-12-01-preview",
"name": "string",
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
}
}
},
"location": "string",
"properties": {
"options": {
"autoscaleSettings": {
"maxThroughput": "int"
},
"throughput": "int"
},
"resource": {
"analyticalStorageTtl": "int",
"createMode": "string",
"id": "string",
"indexes": [
{
"key": {
"keys": [ "string" ]
},
"options": {
"expireAfterSeconds": "int",
"unique": "bool"
}
}
],
"restoreParameters": {
"restoreSource": "string",
"restoreTimestampInUtc": "string",
"restoreWithTtlDisabled": "bool"
},
"shardKey": {
"{customized property}": "string"
}
}
},
"tags": {
"{customized property}": "string"
}
}
属性值
AutoscaleSettings
名字
描述
价值
maxThroughput
表示最大吞吐量，资源可以纵向扩展。
int
Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties
CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions
名字
描述
价值
autoscaleSettings
指定自动缩放设置。 注意：需要吞吐量或自动缩放设置，但不需要两者。
AutoscaleSettings
吞吐量
每秒请求单位数。 例如，“throughput”：10000。
int
ManagedServiceIdentity
名字
描述
价值
类型
用于资源的标识类型。 类型“SystemAssigned，UserAssigned”包括隐式创建的标识和一组用户分配的标识。 类型“None”将从服务中删除任何标识。
“None”
userAssignedIdentities
与资源关联的用户标识列表。 用户标识字典密钥引用的格式为 ARM 资源 ID：“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。
ManagedServiceIdentityUserAssignedIdentities
ManagedServiceIdentityUserAssignedIdentities
Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections
MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties
MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource
名字
描述
价值
分析StorageTtl
分析 TTL。
int
createMode
用于指示资源创建模式的枚举。
“Default”
id
Cosmos DB MongoDB 集合的名称
string （必需）
指标
索引键列表
MongoIndex []
restoreParameters
指示有关还原的信息的参数
ResourceRestoreParameters
shardKey
要为请求应用的分片键的键值对。
ShardKeys
MongoIndex
MongoIndexKeys
名字
描述
价值
钥匙
Azure Cosmos DB 服务中每个 MongoDB 集合的密钥列表
string[]
MongoIndexOptions
名字
描述
价值
expireAfterSeconds
秒后过期
int
独特
唯一或不唯一
bool
ResourceRestoreParameters
名字
描述
价值
restoreSource
必须从中启动还原的可还原数据库帐户的 ID。 例如：/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}
字符串
restoreTimestampInUtc
帐户必须还原到的时间（ISO-8601 格式）。
字符串
restoreWithTtlDisabled
指定还原的帐户是否在成功还原时禁用时间To-Live。
bool
ShardKeys
快速入门模板
以下快速入门模板部署此资源类型。
可以使用目标操作部署 databaseAccounts/mongodbDatabases/collections 资源类型：
有关每个 API 版本中已更改属性的列表，请参阅 更改日志 。
若要创建 Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections 资源，请将以下 Terraform 添加到模板。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2024-12-01-preview"
name = "string"
identity = {
type = "string"
userAssignedIdentities = {
{customized property} = {
}
}
}
location = "string"
tags = {
{customized property} = "string"
}
body = jsonencode({
properties = {
options = {
autoscaleSettings = {
maxThroughput = int
}
throughput = int
}
resource = {
analyticalStorageTtl = int
createMode = "string"
id = "string"
indexes = [
{
key = {
keys = [
"string"
]
}
options = {
expireAfterSeconds = int
unique = bool
}
}
]
restoreParameters = {
restoreSource = "string"
restoreTimestampInUtc = "string"
restoreWithTtlDisabled = bool
}
shardKey = {
{customized property} = "string"
}
}
}
})
}
属性值
AutoscaleSettings
名字
描述
价值
maxThroughput
表示最大吞吐量，资源可以纵向扩展。
int
Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties
CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions
名字
描述
价值
autoscaleSettings
指定自动缩放设置。 注意：需要吞吐量或自动缩放设置，但不需要两者。
AutoscaleSettings
吞吐量
每秒请求单位数。 例如，“throughput”：10000。
int
ManagedServiceIdentity
名字
描述
价值
类型
用于资源的标识类型。 类型“SystemAssigned，UserAssigned”包括隐式创建的标识和一组用户分配的标识。 类型“None”将从服务中删除任何标识。
“None”
userAssignedIdentities
与资源关联的用户标识列表。 用户标识字典密钥引用的格式为 ARM 资源 ID：“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。
ManagedServiceIdentityUserAssignedIdentities
ManagedServiceIdentityUserAssignedIdentities
Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections
MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties
MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource
名字
描述
价值
分析StorageTtl
分析 TTL。
int
createMode
用于指示资源创建模式的枚举。
“Default”
id
Cosmos DB MongoDB 集合的名称
string （必需）
指标
索引键列表
MongoIndex []
restoreParameters
指示有关还原的信息的参数
ResourceRestoreParameters
shardKey
要为请求应用的分片键的键值对。
ShardKeys
MongoIndex
MongoIndexKeys
名字
描述
价值
钥匙
Azure Cosmos DB 服务中每个 MongoDB 集合的密钥列表
string[]
MongoIndexOptions
名字
描述
价值
expireAfterSeconds
秒后过期
int
独特
唯一或不唯一
bool
ResourceRestoreParameters
名字
描述
价值
restoreSource
必须从中启动还原的可还原数据库帐户的 ID。 例如：/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}
字符串
restoreTimestampInUtc
帐户必须还原到的时间（ISO-8601 格式）。
字符串
restoreWithTtlDisabled
指定还原的帐户是否在成功还原时禁用时间To-Live。
bool
ShardKeys
