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

Mongo DB Resources - Get Mongo DB Database Throughput

获取具有提供名称的现有 Azure Cosmos DB 数据库帐户下MongoDB数据库的每秒 RU 数。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/throughputSettings/default?api-version=2021-07-01-preview

URI 参数

Name In Required Type Description
accountName
path True
  • string

Cosmos DB 数据库帐户名称。

Regex pattern: ^[a-z0-9]+(-[a-z0-9]+)*

databaseName
path True
  • string

Cosmos DB 数据库名称。

resourceGroupName
path True
  • string

资源组的名称。 此名称不区分大小写。

subscriptionId
path True
  • string

目标订阅的 ID。

api-version
query True
  • string

要用于此操作的 API 版本。

响应

Name Type Description
200 OK

已成功检索MongoDB数据库的每秒 RU 数。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation 模拟用户帐户

示例

CosmosDBMongoDBDatabaseThroughputGet

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/mongodbDatabases/databaseName/throughputSettings/default?api-version=2021-07-01-preview

Sample Response

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/mongodbDatabases/databaseName/throughputSettings/default",
  "name": "default",
  "type": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings",
  "location": "West US",
  "tags": {},
  "properties": {
    "resource": {
      "throughput": 400,
      "minimumThroughput": "400",
      "offerReplacePending": "true",
      "_rid": "PD5DALigDgw=",
      "_ts": 1459200611,
      "_etag": "\"00005900-0000-0000-0000-56f9a2630000\""
    }
  }
}

定义

AutoscaleSettingsResource

Cosmos DB 预配的吞吐量设置对象

AutoUpgradePolicyResource

Cosmos DB 资源自动升级策略

ManagedServiceIdentity

资源的标识。

Resource
ResourceIdentityType

用于资源的标识的类型。 类型“SystemAssigned,UserAssigned”包括隐式创建的标识和一组用户分配的标识。 类型“None”将从服务中删除任何标识。

ThroughputPolicyResource

Cosmos DB 资源吞吐量策略

ThroughputSettingsGetResults

Azure Cosmos DB 资源吞吐量。

UserAssignedIdentities

与资源关联的用户标识列表。 用户标识字典密钥引用的格式为 ARM 资源 ID:“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。

AutoscaleSettingsResource

Cosmos DB 预配的吞吐量设置对象

Name Type Description
autoUpgradePolicy

Cosmos DB 资源自动升级策略

maxThroughput
  • integer

表示最大吞吐量容器可以纵向扩展。

targetMaxThroughput
  • integer

表示目标最大吞吐量容器可以在产品/服务不再处于挂起状态后纵向扩展。

AutoUpgradePolicyResource

Cosmos DB 资源自动升级策略

Name Type Description
throughputPolicy

表示服务必须遵循的吞吐量策略进行自动升级

ManagedServiceIdentity

资源的标识。

Name Type Description
principalId
  • string

系统分配标识的主体 ID。 此属性仅针对系统分配的标识提供。

tenantId
  • string

系统分配标识的租户 ID。 此属性仅针对系统分配的标识提供。

type

用于资源的标识的类型。 类型“SystemAssigned,UserAssigned”包括隐式创建的标识和一组用户分配的标识。 类型“None”将从服务中删除任何标识。

userAssignedIdentities

与资源关联的用户标识列表。 用户标识字典密钥引用的格式为 ARM 资源 ID:“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。

Resource

Name Type Description
_etag
  • string

一个系统生成的属性,表示乐观并发控制所需的资源 etag。

_rid
  • string

系统生成的属性。 唯一标识符。

_ts
  • number

一个系统生成的属性,表示资源的上次更新时间戳。

autoscaleSettings

Cosmos自动缩放设置的 DB 资源。 需要吞吐量,或者需要自动缩放Settings,但不需要这两者。

minimumThroughput
  • string

资源的最低吞吐量

offerReplacePending
  • string

吞吐量替换处于挂起状态

throughput
  • integer

Cosmos DB 资源吞吐量的值。 需要吞吐量,或者需要自动缩放Settings,但不需要这两者。

ResourceIdentityType

用于资源的标识的类型。 类型“SystemAssigned,UserAssigned”包括隐式创建的标识和一组用户分配的标识。 类型“None”将从服务中删除任何标识。

Name Type Description
None
  • string
SystemAssigned
  • string
SystemAssigned,UserAssigned
  • string
UserAssigned
  • string

ThroughputPolicyResource

Cosmos DB 资源吞吐量策略

Name Type Description
incrementPercent
  • integer

表示每次启动吞吐量策略时吞吐量可能会增加的百分比。

isEnabled
  • boolean

确定 ThroughputPolicy 是否处于活动状态

ThroughputSettingsGetResults

Azure Cosmos DB 资源吞吐量。

Name Type Description
id
  • string

ARM 资源的唯一资源标识符。

identity

资源的标识。

location
  • string

资源所属的资源组的位置。

name
  • string

ARM 资源的名称。

properties.resource
tags
  • object

标记是描述资源的键值对的列表。 在查看此资源和为此资源分组(跨资源组)时,可以使用这些标记。 最多可以为资源提供 15 个标记。 每个标记的键不能超过 128 个字符,值不能超过 256 个字符。 例如,模板类型的默认体验设置为“defaultExperience”:“Cassandra”。 当前的“defaultExperience”值还包括“Table”、“Graph”、“DocumentDB”和“MongoDB”。

type
  • string

Azure 资源的类型。

UserAssignedIdentities

与资源关联的用户标识列表。 用户标识字典密钥引用的格式为 ARM 资源 ID:“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。

Name Type Description