Database.ReadThroughputAsync Method
Definition
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.
Overloads
| ReadThroughputAsync(CancellationToken) |
Gets database throughput in measurement of request units per second in the Azure Cosmos service. |
| ReadThroughputAsync(RequestOptions, CancellationToken) |
Gets database throughput in measurement of request units per second in the Azure Cosmos service. |
ReadThroughputAsync(CancellationToken)
- Source:
- Database.cs
Gets database throughput in measurement of request units per second in the Azure Cosmos service.
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))Parameters
- cancellationToken
- CancellationToken
(Optional) CancellationToken representing request cancellation.
Returns
Provisioned throughput in request units per second
Examples
The following example shows how to get database throughput.
int? throughput = await database.ReadThroughputAsync();
Remarks
Null value indicates a database with no throughput provisioned.
Applies to
ReadThroughputAsync(RequestOptions, CancellationToken)
- Source:
- Database.cs
Gets database throughput in measurement of request units per second in the Azure Cosmos service.
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)Parameters
- requestOptions
- RequestOptions
The options for the throughput request.
- cancellationToken
- CancellationToken
(Optional) CancellationToken representing request cancellation.
Returns
The throughput response.
Exceptions
This exception can encapsulate many different types of errors. To determine the specific error always look at the StatusCode property. Some common codes you may get when reading a client encryption key are:
| StatusCode | Reason for exception |
|---|---|
| 404 | NotFound - This means the database does not exist or has no throughput assigned. |
Examples
The following example shows how to get the throughput
RequestOptions requestOptions = new RequestOptions();
ThroughputProperties throughputProperties = await database.ReadThroughputAsync(requestOptions);
Console.WriteLine($"Throughput: {throughputProperties?.Throughput}");
The following example shows how to get throughput, MinThroughput and is replace in progress
RequestOptions requestOptions = new RequestOptions();
ThroughputResponse response = await database.ReadThroughputAsync(requestOptions);
Console.WriteLine($"Throughput: {response.Resource?.Throughput}");
Console.WriteLine($"MinThroughput: {response.MinThroughput}");
Console.WriteLine($"IsReplacePending: {response.IsReplacePending}");
