你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
Microsoft.DocumentDB databaseAccounts/mongodbDatabases/collections/throughputSettings 2021-06-15
Bicep 资源定义
可以使用面向以下操作部署 databaseAccounts/mongodbDatabases/collections/throughputSettings 资源类型：
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
若要创建 Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings 资源，请将以下 Bicep 添加到模板。
resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings@2021-06-15' = {
name: 'default'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
parent: resourceSymbolicName
properties: {
resource: {
autoscaleSettings: {
autoUpgradePolicy: {
throughputPolicy: {
incrementPercent: int
isEnabled: bool
}
}
maxThroughput: int
}
throughput: int
}
}
}
属性值
databaseAccounts/mongodbDatabases/collections/throug...
| 名称 |
说明 |
值 |
| name |
资源名称
了解如何在 Bicep 中设置子资源的名称和类型。 |
'default' |
| location |
资源所属的资源组的位置。 |
字符串 |
| 标记 |
标记是描述资源的键值对的列表。 在查看此资源和为此资源分组（跨资源组）时，可以使用这些标记。 最多可以为资源提供 15 个标记。 每个标记的键不能超过 128 个字符，值不能超过 256 个字符。 例如，模板类型的默认体验设置为“defaultExperience”：“Cassandra”。 当前的“defaultExperience”值还包括“Table”、“Graph”、“DocumentDB”和“MongoDB”。 |
标记名称和值的字典。 请参阅 模板中的标记 |
| 父级 (parent) |
在 Bicep 中，可以为子资源指定父资源。 仅当子资源在父资源外部声明时，才需要添加此属性。
有关详细信息，请参阅 父资源之外的子资源。 |
类型为：集合的资源的符号名称 |
| properties |
用于更新 Azure Cosmos DB 资源吞吐量的属性。 |
ThroughputSettingsUpdatePropertiesOrThroughputSettin... 所需的 () |
ThroughputSettingsUpdatePropertiesOrThroughputSettin...
ThroughputSettingsResourceOrThroughputSettingsGetPro...
| 名称 |
说明 |
值 |
| autoscaleSettings |
用于自动缩放设置的 Cosmos DB 资源。 需要吞吐量，或者需要 autoscaleSettings，但不能同时满足这两项要求。 |
AutoscaleSettingsResource |
| throughput |
Cosmos DB 资源吞吐量的值。 需要吞吐量，或者需要 autoscaleSettings，但不能同时满足这两项要求。 |
int |
AutoscaleSettingsResource
AutoUpgradePolicyResource
ThroughputPolicyResource
| 名称 |
说明 |
值 |
| incrementPercent |
表示每次启动吞吐量策略时吞吐量增加的百分比。 |
int |
| isEnabled |
确定 ThroughputPolicy 是否处于活动状态 |
bool |
ARM 模板资源定义
可以使用面向以下操作部署 databaseAccounts/mongodbDatabases/collections/throughputSettings 资源类型：
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
若要创建 Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings 资源，请将以下 JSON 添加到模板。
{
"type": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings",
"apiVersion": "2021-06-15",
"name": "default",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"properties": {
"resource": {
"autoscaleSettings": {
"autoUpgradePolicy": {
"throughputPolicy": {
"incrementPercent": "int",
"isEnabled": "bool"
}
},
"maxThroughput": "int"
},
"throughput": "int"
}
}
}
属性值
databaseAccounts/mongodbDatabases/collections/throug...
| 名称 |
说明 |
Value |
| type |
资源类型 |
'Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings' |
| apiVersion |
资源 API 版本 |
'2021-06-15' |
| name |
资源名称
了解如何在 JSON ARM 模板中设置子资源的名称和类型。 |
'default' |
| location |
资源所属的资源组的位置。 |
字符串 |
| 标记 |
标记是描述资源的键值对的列表。 在查看此资源和为此资源分组（跨资源组）时，可以使用这些标记。 最多可以为资源提供 15 个标记。 每个标记的键不能超过 128 个字符，值不能超过 256 个字符。 例如，模板类型的默认体验设置为“defaultExperience”：“Cassandra”。 当前的“defaultExperience”值还包括“Table”、“Graph”、“DocumentDB”和“MongoDB”。 |
标记名称和值的字典。 请参阅 模板中的标记 |
| properties |
用于更新 Azure Cosmos DB 资源吞吐量的属性。 |
ThroughputSettingsUpdatePropertiesOrThroughputSettin... 所需的 () |
ThroughputSettingsUpdatePropertiesOrThroughputSettin...
ThroughputSettingsResourceOrThroughputSettingsGetPro...
| 名称 |
说明 |
值 |
| autoscaleSettings |
用于自动缩放设置的 Cosmos DB 资源。 需要吞吐量，或者需要 autoscaleSettings，但不能同时满足这两项要求。 |
AutoscaleSettingsResource |
| throughput |
Cosmos DB 资源吞吐量的值。 需要吞吐量，或者需要 autoscaleSettings，但不能同时满足这两项要求。 |
int |
AutoscaleSettingsResource
AutoUpgradePolicyResource
ThroughputPolicyResource
| 名称 |
说明 |
值 |
| incrementPercent |
表示每次启动吞吐量策略时吞吐量增加的百分比。 |
int |
| isEnabled |
确定 ThroughputPolicy 是否处于活动状态 |
bool |
databaseAccounts/mongodbDatabases/collections/throughputSettings 资源类型可以使用面向以下对象的操作进行部署：
有关每个 API 版本中更改的属性的列表，请参阅 更改日志。
若要创建 Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings 资源，请将以下 Terraform 添加到模板。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings@2021-06-15"
name = "default"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
body = jsonencode({
properties = {
resource = {
autoscaleSettings = {
autoUpgradePolicy = {
throughputPolicy = {
incrementPercent = int
isEnabled = bool
}
}
maxThroughput = int
}
throughput = int
}
}
})
}
属性值
databaseAccounts/mongodbDatabases/collections/throug...
| 名称 |
说明 |
Value |
| type |
资源类型 |
“Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings@2021-06-15” |
| name |
资源名称 |
"default" |
| location |
资源所属的资源组的位置。 |
字符串 |
| parent_id |
此资源的父资源 ID。 |
类型为“集合”的资源的 ID |
| 标记 |
标记是描述资源的键值对的列表。 在查看此资源和为此资源分组（跨资源组）时，可以使用这些标记。 最多可以为一个资源提供 15 个标记。 每个标记的键不能超过 128 个字符，值不能超过 256 个字符。 例如，模板类型的默认体验设置为“defaultExperience”：“Cassandra”。 当前的“defaultExperience”值还包括“Table”、“Graph”、“DocumentDB”和“MongoDB”。 |
标记名称和值的字典。 |
| properties |
用于更新 Azure Cosmos DB 资源吞吐量的属性。 |
ThroughputSettingsUpdatePropertiesOrThroughputSettin... 所需的 () |
ThroughputSettingsUpdatePropertiesOrThroughputSettin...
ThroughputSettingsResourceOrThroughputSettingsGetPro...
| 名称 |
说明 |
值 |
| autoscaleSettings |
用于自动缩放设置的 Cosmos DB 资源。 需要吞吐量，或者需要自动缩放设置，但不能同时满足两者。 |
AutoscaleSettingsResource |
| throughput |
Cosmos DB 资源吞吐量的值。 需要吞吐量，或者需要自动缩放设置，但不能同时满足两者。 |
int |
AutoscaleSettingsResource
AutoUpgradePolicyResource
ThroughputPolicyResource
| 名称 |
说明 |
值 |
| incrementPercent |
表示每次启动吞吐量策略时吞吐量可以增加的百分比。 |
int |
| isEnabled |
确定 ThroughputPolicy 是否处于活动状态 |
bool |