Container.ReadThroughputAsync メソッド

定義

名前空間:

Microsoft.Azure.Cosmos

アセンブリ:

Microsoft.Azure.Cosmos.Client.dll

パッケージ:

Microsoft.Azure.Cosmos v3.36.0

オーバーロード

ReadThroughputAsync(CancellationToken)	Azure Cosmos サービスの 1 秒あたりの要求ユニット数の測定におけるコンテナー スループットを取得します。
ReadThroughputAsync(RequestOptions, CancellationToken)	Azure Cosmos サービスの 1 秒あたりの要求ユニット数の測定におけるコンテナー スループットを取得します。

ReadThroughputAsync(CancellationToken)

Azure Cosmos サービスの 1 秒あたりの要求ユニット数の測定におけるコンテナー スループットを取得します。

public abstract System.Threading.Tasks.Task<int?> ReadThroughputAsync (System.Threading.CancellationToken cancellationToken = default);

abstract member ReadThroughputAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<Nullable<int>>

Public MustOverride Function ReadThroughputAsync (Optional cancellationToken As CancellationToken = Nothing) As Task(Of Nullable(Of Integer))

パラメーター

cancellationToken

CancellationToken

(省略可能) CancellationToken 要求の取り消しを表します。

戻り値

Task<Nullable<Int32>>

プロビジョニングされたスループット (1 秒あたりの要求ユニット数)

例

次の例は、スループットを取得する方法を示しています。

int? throughput = await container.ReadThroughputAsync();

注釈

Null 値は、スループットがプロビジョニングされていないコンテナーを示します。

ReadThroughputAsync(RequestOptions, CancellationToken)

Azure Cosmos サービスの 1 秒あたりの要求ユニット数の測定におけるコンテナー スループットを取得します。

public abstract System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.ThroughputResponse> ReadThroughputAsync (Microsoft.Azure.Cosmos.RequestOptions requestOptions, System.Threading.CancellationToken cancellationToken = default);

abstract member ReadThroughputAsync : Microsoft.Azure.Cosmos.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.ThroughputResponse>

Public MustOverride Function ReadThroughputAsync (requestOptions As RequestOptions, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ThroughputResponse)

パラメーター

requestOptions

RequestOptions

スループット要求のオプション。

cancellationToken

CancellationToken

(省略可能) CancellationToken 要求の取り消しを表します。

戻り値

Task<ThroughputResponse>

スループット応答

例

次の例は、スループットを取得する方法を示しています

RequestOptions requestOptions = new RequestOptions();
ThroughputProperties throughputProperties = await container.ReadThroughputAsync(requestOptions);
Console.WriteLine($"Throughput: {throughputProperties?.Throughput}");

次の例は、スループットを取得する方法を示しています。MinThroughput と が進行中で置き換えられます

RequestOptions requestOptions = new RequestOptions();
ThroughputResponse response = await container.ReadThroughputAsync(requestOptions);
Console.WriteLine($"Throughput: {response.Resource?.Throughput}");
Console.WriteLine($"MinThroughput: {response.MinThroughput}");
Console.WriteLine($"IsReplacePending: {response.IsReplacePending}");

注釈

プロビジョニング オファーの http://azure.microsoft.com/documentation/articles/documentdb-performance-levels/ スループットの詳細については、こちらを参照してください。