Sprog

MongoDBCollectionThroughputSettingResource.MongoDBContainerRetrieveThroughputDistributionAsync Method

Definition

Namespace:
Azure.ResourceManager.CosmosDB
Assembly:
Azure.ResourceManager.CosmosDB.dll
Package:
Azure.ResourceManager.CosmosDB v1.6.0-beta.1
Source:
MongoDBCollectionThroughputSettingResource.cs

Retrieve throughput distribution for an Azure Cosmos DB MongoDB container

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections/{collectionName}/throughputSettings/default/retrieveThroughputDistribution.
  • Operation Id. : MongoDBResourcesThroughputSettingsGetResultsOperationGroup_MongoDBContainerRetrieveThroughputDistribution.
  • Default Api Version. : 2026-04-01-preview.
  • Resource. : MongoDBCollectionThroughputSettingResource. 
public virtual System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.CosmosDB.Models.CosmosDBPhysicalPartitionThroughputResult>> MongoDBContainerRetrieveThroughputDistributionAsync(Azure.WaitUntil waitUntil, Azure.ResourceManager.CosmosDB.Models.RetrieveThroughputContent content, System.Threading.CancellationToken cancellationToken = default);
abstract member MongoDBContainerRetrieveThroughputDistributionAsync : Azure.WaitUntil * Azure.ResourceManager.CosmosDB.Models.RetrieveThroughputContent * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.CosmosDB.Models.CosmosDBPhysicalPartitionThroughputResult>>
override this.MongoDBContainerRetrieveThroughputDistributionAsync : Azure.WaitUntil * Azure.ResourceManager.CosmosDB.Models.RetrieveThroughputContent * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.CosmosDB.Models.CosmosDBPhysicalPartitionThroughputResult>>
Public Overridable Function MongoDBContainerRetrieveThroughputDistributionAsync (waitUntil As WaitUntil, content As RetrieveThroughputContent, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ArmOperation(Of CosmosDBPhysicalPartitionThroughputResult))

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.

content
RetrieveThroughputContent

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

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Task<ArmOperation<CosmosDBPhysicalPartitionThroughputResult>>

Exceptions

ArgumentNullException

content is null.

Applies to