通过

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

MongoDBDatabaseThroughputSettingResource.MongoDBDatabaseRetrieveThroughputDistributionAsync Method

Definition

Namespace:
Azure.ResourceManager.CosmosDB
Assembly:
Azure.ResourceManager.CosmosDB.dll
Package:
Azure.ResourceManager.CosmosDB v1.4.0-beta.13
Source:
MongoDBDatabaseThroughputSettingResource.cs

Retrieve throughput distribution for an Azure Cosmos DB MongoDB database

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/throughputSettings/default/retrieveThroughputDistribution
  • Operation Id: MongoDBResources_MongoDBDatabaseRetrieveThroughputDistribution
  • Default Api Version: 2024-12-01-preview
  • Resource: MongoDBDatabaseThroughputSettingResource
public virtual System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.CosmosDB.Models.PhysicalPartitionThroughputInfoResult>> MongoDBDatabaseRetrieveThroughputDistributionAsync(Azure.WaitUntil waitUntil, Azure.ResourceManager.CosmosDB.Models.RetrieveThroughputParameters retrieveThroughputParameters, System.Threading.CancellationToken cancellationToken = default);
abstract member MongoDBDatabaseRetrieveThroughputDistributionAsync : Azure.WaitUntil * Azure.ResourceManager.CosmosDB.Models.RetrieveThroughputParameters * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.CosmosDB.Models.PhysicalPartitionThroughputInfoResult>>
override this.MongoDBDatabaseRetrieveThroughputDistributionAsync : Azure.WaitUntil * Azure.ResourceManager.CosmosDB.Models.RetrieveThroughputParameters * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.CosmosDB.Models.PhysicalPartitionThroughputInfoResult>>
Public Overridable Function MongoDBDatabaseRetrieveThroughputDistributionAsync (waitUntil As WaitUntil, retrieveThroughputParameters As RetrieveThroughputParameters, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ArmOperation(Of PhysicalPartitionThroughputInfoResult))

Parameters

waitUntil
WaitUntil

Completed if the method should wait to return until the long-running operation has completed on the service; Started if it should return after starting the operation. For more information on long-running operations, please see Azure.Core Long-Running Operation samples.

retrieveThroughputParameters
RetrieveThroughputParameters

The parameters to provide for retrieving throughput distribution for the current MongoDB database.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Task<ArmOperation<PhysicalPartitionThroughputInfoResult>>

Exceptions

ArgumentNullException

retrieveThroughputParameters is null.

Applies to