MongoDBCollectionThroughputSettingResource.MongoDBContainerRetrieveThroughputDistribution Method

Reference

Definition

Namespace:: Azure.ResourceManager.CosmosDB

Assembly:: Azure.ResourceManager.CosmosDB.dll

Package:: Azure.ResourceManager.CosmosDB v1.4.0-beta.11

Source:: MongoDBCollectionThroughputSettingResource.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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: MongoDBResources_MongoDBContainerRetrieveThroughputDistribution
Default Api Version: 2024-09-01-preview
Resource: MongoDBCollectionThroughputSettingResource

public virtual Azure.ResourceManager.ArmOperation<Azure.ResourceManager.CosmosDB.Models.PhysicalPartitionThroughputInfoResult> MongoDBContainerRetrieveThroughputDistribution (Azure.WaitUntil waitUntil, Azure.ResourceManager.CosmosDB.Models.RetrieveThroughputParameters retrieveThroughputParameters, System.Threading.CancellationToken cancellationToken = default);

abstract member MongoDBContainerRetrieveThroughputDistribution : Azure.WaitUntil * Azure.ResourceManager.CosmosDB.Models.RetrieveThroughputParameters * System.Threading.CancellationToken -> Azure.ResourceManager.ArmOperation<Azure.ResourceManager.CosmosDB.Models.PhysicalPartitionThroughputInfoResult>
override this.MongoDBContainerRetrieveThroughputDistribution : Azure.WaitUntil * Azure.ResourceManager.CosmosDB.Models.RetrieveThroughputParameters * System.Threading.CancellationToken -> Azure.ResourceManager.ArmOperation<Azure.ResourceManager.CosmosDB.Models.PhysicalPartitionThroughputInfoResult>

Public Overridable Function MongoDBContainerRetrieveThroughputDistribution (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 container.

cancellationToken: CancellationToken

The cancellation token to use.

Returns

ArmOperation<PhysicalPartitionThroughputInfoResult>

Exceptions

ArgumentNullException

retrieveThroughputParameters is null.

Applies to

Share via