MongoDBCollectionThroughputSettingResource.MongoDBContainerRetrieveThroughputDistributionAsync メソッド

定義

名前空間:

Azure.ResourceManager.CosmosDB

アセンブリ:

Azure.ResourceManager.CosmosDB.dll

パッケージ:

Azure.ResourceManager.CosmosDB v1.4.0-beta.5

Azure Cosmos DB MongoDB コンテナーのスループット分散を取得する

• 要求パス/サブスクリプション/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections/{collectionName}/throughputSettings/default/retrieveThroughputDistribution
• 操作IdMongoDBResources_MongoDBContainerRetrieveThroughputDistribution

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

abstract member MongoDBContainerRetrieveThroughputDistributionAsync : Azure.WaitUntil * Azure.ResourceManager.CosmosDB.Models.RetrieveThroughputParameters * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.CosmosDB.Models.PhysicalPartitionThroughputInfoResult>>
override this.MongoDBContainerRetrieveThroughputDistributionAsync : 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 MongoDBContainerRetrieveThroughputDistributionAsync (waitUntil As WaitUntil, retrieveThroughputParameters As RetrieveThroughputParameters, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ArmOperation(Of PhysicalPartitionThroughputInfoResult))

パラメーター

waitUntil

WaitUntil

Completed メソッドが、サービスで実行時間の長い操作が完了するまで戻るまで待機する必要がある場合。 Started 操作を開始した後に が返される場合は 。 実行時間の長い操作の詳細については、「 Azure.Core Long-Running 操作のサンプル」を参照してください。

retrieveThroughputParameters

RetrieveThroughputParameters

現在の MongoDB コンテナーのスループット分布を取得するために提供するパラメーター。

cancellationToken

CancellationToken

使用する取り消しトークン。

戻り値

Task<ArmOperation<PhysicalPartitionThroughputInfoResult>>

例外

ArgumentNullException

retrieveThroughputParameters が null です。