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

Microsoft.DocumentDB databaseAccounts/mongodbDatabases/collections/throughputSettings 2022-02-15-preview

• 最新
• 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

Bicep 资源定义

可以使用目标操作部署 databaseAccounts/mongodbDatabases/collections/throughputSettings 资源类型：

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

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

资源格式

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

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings@2022-02-15-preview' = {
  parent: resourceSymbolicName
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'default'
  properties: {
    resource: {
      autoscaleSettings: {
        autoUpgradePolicy: {
          throughputPolicy: {
            incrementPercent: int
            isEnabled: bool
          }
        }
        maxThroughput: int
      }
      throughput: int
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

属性值

AutoscaleSettingsResource

名字	描述	价值
autoUpgradePolicy	Cosmos DB 资源自动升级策略	AutoUpgradePolicyResource
maxThroughput	表示最大吞吐量容器可以纵向扩展。	int （必需）

AutoUpgradePolicyResource

名字	描述	价值
throughputPolicy	表示服务必须遵循的吞吐量策略，以便自动升级	ThroughputPolicyResource

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

名字	描述	价值

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/mongodbDatabases/collections/throughputSettings

名字	描述	价值
身份	资源的标识。	ManagedServiceIdentity
位置	资源所属的资源组的位置。	字符串
名字	资源名称	“default”（必需）
父母	在 Bicep 中，可以为子资源指定父资源。 仅当子资源在父资源外部声明时，才需要添加此属性。 有关详细信息，请参阅 父资源外部的子资源。	类型资源的符号名称：databaseAccounts/mongodbDatabases/collections
性能	用于更新 Azure Cosmos DB 资源吞吐量的属性。	ThroughputSettingsUpdatePropertiesOrThroughputSettingsGetProperties（必需）
标签	资源标记	标记名称和值的字典。 请参阅模板 中的 标记

标签

名字	描述	价值

ThroughputPolicyResource

名字	描述	价值
incrementPercent	表示每次启动吞吐量策略时吞吐量可能会增加的百分比。	int
isEnabled	确定 ThroughputPolicy 是否处于活动状态	bool

ThroughputSettingsResourceOrThroughputSettingsGetPropertiesResource

名字	描述	价值
autoscaleSettings	用于自动缩放设置的 Cosmos DB 资源。 需要吞吐量或自动缩放设置是必需的，但不需要两者。	AutoscaleSettingsResource
吞吐量	Cosmos DB 资源吞吐量的值。 需要吞吐量或自动缩放设置是必需的，但不需要两者。	int

ThroughputSettingsUpdatePropertiesOrThroughputSettingsGetProperties

名字	描述	价值
资源	资源吞吐量的标准 JSON 格式	ThroughputSettingsResourceOrThroughputSettingsGetPropertiesResource（必需）

ARM 模板资源定义

可以使用目标操作部署 databaseAccounts/mongodbDatabases/collections/throughputSettings 资源类型：

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

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

资源格式

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

{
  "type": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings",
  "apiVersion": "2022-02-15-preview",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "location": "string",
  "properties": {
    "resource": {
      "autoscaleSettings": {
        "autoUpgradePolicy": {
          "throughputPolicy": {
            "incrementPercent": "int",
            "isEnabled": "bool"
          }
        },
        "maxThroughput": "int"
      },
      "throughput": "int"
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

属性值

AutoscaleSettingsResource

名字	描述	价值
autoUpgradePolicy	Cosmos DB 资源自动升级策略	AutoUpgradePolicyResource
maxThroughput	表示最大吞吐量容器可以纵向扩展。	int （必需）

AutoUpgradePolicyResource

名字	描述	价值
throughputPolicy	表示服务必须遵循的吞吐量策略，以便自动升级	ThroughputPolicyResource

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

名字	描述	价值

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/mongodbDatabases/collections/throughputSettings

名字	描述	价值
apiVersion	API 版本	'2022-02-15-preview'
身份	资源的标识。	ManagedServiceIdentity
位置	资源所属的资源组的位置。	字符串
名字	资源名称	“default”（必需）
性能	用于更新 Azure Cosmos DB 资源吞吐量的属性。	ThroughputSettingsUpdatePropertiesOrThroughputSettingsGetProperties（必需）
标签	资源标记	标记名称和值的字典。 请参阅模板 中的 标记
类型	资源类型	“Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings”

标签

名字	描述	价值

ThroughputPolicyResource

名字	描述	价值
incrementPercent	表示每次启动吞吐量策略时吞吐量可能会增加的百分比。	int
isEnabled	确定 ThroughputPolicy 是否处于活动状态	bool

ThroughputSettingsResourceOrThroughputSettingsGetPropertiesResource

名字	描述	价值
autoscaleSettings	用于自动缩放设置的 Cosmos DB 资源。 需要吞吐量或自动缩放设置是必需的，但不需要两者。	AutoscaleSettingsResource
吞吐量	Cosmos DB 资源吞吐量的值。 需要吞吐量或自动缩放设置是必需的，但不需要两者。	int

ThroughputSettingsUpdatePropertiesOrThroughputSettingsGetProperties

名字	描述	价值
资源	资源吞吐量的标准 JSON 格式	ThroughputSettingsResourceOrThroughputSettingsGetPropertiesResource（必需）

Terraform （AzAPI 提供程序）资源定义

可以使用目标操作部署 databaseAccounts/mongodbDatabases/collections/throughputSettings 资源类型：

• 资源组

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

资源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings@2022-02-15-preview"
  name = "string"
  identity = {
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
      }
    }
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      resource = {
        autoscaleSettings = {
          autoUpgradePolicy = {
            throughputPolicy = {
              incrementPercent = int
              isEnabled = bool
            }
          }
          maxThroughput = int
        }
        throughput = int
      }
    }
  })
}

属性值

AutoscaleSettingsResource

名字	描述	价值
autoUpgradePolicy	Cosmos DB 资源自动升级策略	AutoUpgradePolicyResource
maxThroughput	表示最大吞吐量容器可以纵向扩展。	int （必需）

AutoUpgradePolicyResource

名字	描述	价值
throughputPolicy	表示服务必须遵循的吞吐量策略，以便自动升级	ThroughputPolicyResource

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

名字	描述	价值

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/mongodbDatabases/collections/throughputSettings

名字	描述	价值
身份	资源的标识。	ManagedServiceIdentity
位置	资源所属的资源组的位置。	字符串
名字	资源名称	“default”（必需）
parent_id	此资源的父资源的 ID。	类型资源的 ID：databaseAccounts/mongodbDatabases/collections
性能	用于更新 Azure Cosmos DB 资源吞吐量的属性。	ThroughputSettingsUpdatePropertiesOrThroughputSettingsGetProperties（必需）
标签	资源标记	标记名称和值的字典。
类型	资源类型	“Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings@2022-02-15-preview”

标签

名字	描述	价值

ThroughputPolicyResource

名字	描述	价值
incrementPercent	表示每次启动吞吐量策略时吞吐量可能会增加的百分比。	int
isEnabled	确定 ThroughputPolicy 是否处于活动状态	bool

ThroughputSettingsResourceOrThroughputSettingsGetPropertiesResource

名字	描述	价值
autoscaleSettings	用于自动缩放设置的 Cosmos DB 资源。 需要吞吐量或自动缩放设置是必需的，但不需要两者。	AutoscaleSettingsResource
吞吐量	Cosmos DB 资源吞吐量的值。 需要吞吐量或自动缩放设置是必需的，但不需要两者。	int

ThroughputSettingsUpdatePropertiesOrThroughputSettingsGetProperties

名字	描述	价值
资源	资源吞吐量的标准 JSON 格式	ThroughputSettingsResourceOrThroughputSettingsGetPropertiesResource（必需）