CosmosDBThroughputPoolResource.UpdateAsync 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.
Updates the properties of an existing Azure Cosmos DB Throughput Pool.
- Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/throughputPools/{throughputPoolName}
- Operation Id: ThroughputPool_Update
- Default Api Version: 2024-09-01-preview
- Resource: CosmosDBThroughputPoolResource
public virtual System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.CosmosDB.CosmosDBThroughputPoolResource>> UpdateAsync (Azure.WaitUntil waitUntil, Azure.ResourceManager.CosmosDB.Models.CosmosDBThroughputPoolPatch patch, System.Threading.CancellationToken cancellationToken = default);
abstract member UpdateAsync : Azure.WaitUntil * Azure.ResourceManager.CosmosDB.Models.CosmosDBThroughputPoolPatch * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.CosmosDB.CosmosDBThroughputPoolResource>>
override this.UpdateAsync : Azure.WaitUntil * Azure.ResourceManager.CosmosDB.Models.CosmosDBThroughputPoolPatch * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.CosmosDB.CosmosDBThroughputPoolResource>>
Public Overridable Function UpdateAsync (waitUntil As WaitUntil, patch As CosmosDBThroughputPoolPatch, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ArmOperation(Of CosmosDBThroughputPoolResource))
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.
The parameters to provide for the current Throughput Pool.
- cancellationToken
- CancellationToken
The cancellation token to use.
Returns
Exceptions
patch
is null.
Applies to
Azure SDK for .NET