MongoDBDatabaseThroughputSettingResource.MongoDBDatabaseRetrieveThroughputDistribution Method

Definition

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-05-15-preview
  • Resource: MongoDBDatabaseThroughputSettingResource
public virtual Azure.ResourceManager.ArmOperation<Azure.ResourceManager.CosmosDB.Models.PhysicalPartitionThroughputInfoResult> MongoDBDatabaseRetrieveThroughputDistribution (Azure.WaitUntil waitUntil, Azure.ResourceManager.CosmosDB.Models.RetrieveThroughputParameters retrieveThroughputParameters, System.Threading.CancellationToken cancellationToken = default);
abstract member MongoDBDatabaseRetrieveThroughputDistribution : Azure.WaitUntil * Azure.ResourceManager.CosmosDB.Models.RetrieveThroughputParameters * System.Threading.CancellationToken -> Azure.ResourceManager.ArmOperation<Azure.ResourceManager.CosmosDB.Models.PhysicalPartitionThroughputInfoResult>
override this.MongoDBDatabaseRetrieveThroughputDistribution : Azure.WaitUntil * Azure.ResourceManager.CosmosDB.Models.RetrieveThroughputParameters * System.Threading.CancellationToken -> Azure.ResourceManager.ArmOperation<Azure.ResourceManager.CosmosDB.Models.PhysicalPartitionThroughputInfoResult>
Public Overridable Function MongoDBDatabaseRetrieveThroughputDistribution (waitUntil As WaitUntil, retrieveThroughputParameters As RetrieveThroughputParameters, Optional cancellationToken As CancellationToken = Nothing) As 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

Exceptions

retrieveThroughputParameters is null.

Applies to