Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
Container.ReplaceThroughputAsync Method
Definition
- Namespace:
- Microsoft.Azure.Cosmos
- Assembly:
- Microsoft.Azure.Cosmos.Client.dll
- Package:
- Microsoft.Azure.Cosmos v3.58.0
- Package:
- Microsoft.Azure.Cosmos v3.59.0-preview.0
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
| Name | Description |
|---|---|
| ReplaceThroughputAsync(ThroughputProperties, RequestOptions, CancellationToken) |
Sets throughput provisioned for a container in measurement of request units per second in the Azure Cosmos service. |
| ReplaceThroughputAsync(Int32, RequestOptions, CancellationToken) |
Sets throughput provisioned for a container in measurement of request units per second in the Azure Cosmos service. |
ReplaceThroughputAsync(ThroughputProperties, RequestOptions, CancellationToken)
- Source:
- Container.cs
Sets throughput provisioned for a container in measurement of request units per second in the Azure Cosmos service.
public abstract System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.ThroughputResponse> ReplaceThroughputAsync(Microsoft.Azure.Cosmos.ThroughputProperties throughputProperties, Microsoft.Azure.Cosmos.RequestOptions requestOptions = default, System.Threading.CancellationToken cancellationToken = default);abstract member ReplaceThroughputAsync : Microsoft.Azure.Cosmos.ThroughputProperties * Microsoft.Azure.Cosmos.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.ThroughputResponse>Public MustOverride Function ReplaceThroughputAsync (throughputProperties As ThroughputProperties, Optional requestOptions As RequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ThroughputResponse)Parameters
- throughputProperties
- ThroughputProperties
The Cosmos container throughput expressed in Request Units per second.
- requestOptions
- RequestOptions
(Optional) The options for the throughput request.
- cancellationToken
- CancellationToken
(Optional) CancellationToken representing request cancellation.
Returns
The throughput response.
Examples
The following example shows how to replace the fixed throughput.
ThroughputResponse throughput = await this.cosmosContainer.ReplaceThroughputAsync(
ThroughputProperties.CreateManualThroughput(10000));
The following example shows how to replace the autoscale provisioned throughput
ThroughputResponse throughput = await this.cosmosContainer.ReplaceThroughputAsync(
ThroughputProperties.CreateAutoscaleThroughput(10000));
Remarks
Request Units Set throughput on a container
Applies to
ReplaceThroughputAsync(Int32, RequestOptions, CancellationToken)
- Source:
- Container.cs
Sets throughput provisioned for a container in measurement of request units per second in the Azure Cosmos service.
public abstract System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.ThroughputResponse> ReplaceThroughputAsync(int throughput, Microsoft.Azure.Cosmos.RequestOptions requestOptions = default, System.Threading.CancellationToken cancellationToken = default);abstract member ReplaceThroughputAsync : int * Microsoft.Azure.Cosmos.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.ThroughputResponse>Public MustOverride Function ReplaceThroughputAsync (throughput As Integer, Optional requestOptions As RequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ThroughputResponse)Parameters
- throughput
- Int32
The Cosmos container throughput, expressed in Request Units per second.
- requestOptions
- RequestOptions
(Optional) The options for the throughput request.
- cancellationToken
- CancellationToken
(Optional) CancellationToken representing request cancellation.
Returns
The throughput response.
Examples
The following example shows how to get the throughput.
ThroughputResponse throughput = await this.cosmosContainer.ReplaceThroughputAsync(400);
Applies to
Azure SDK for .NET
Feedback
Was this page helpful?