Dela via


CosmosDBThroughputPoolResource.Update Method

Definition

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-05-15-preview
  • Resource: CosmosDBThroughputPoolResource
public virtual Azure.ResourceManager.ArmOperation<Azure.ResourceManager.CosmosDB.CosmosDBThroughputPoolResource> Update (Azure.WaitUntil waitUntil, Azure.ResourceManager.CosmosDB.Models.CosmosDBThroughputPoolPatch patch, System.Threading.CancellationToken cancellationToken = default);
abstract member Update : Azure.WaitUntil * Azure.ResourceManager.CosmosDB.Models.CosmosDBThroughputPoolPatch * System.Threading.CancellationToken -> Azure.ResourceManager.ArmOperation<Azure.ResourceManager.CosmosDB.CosmosDBThroughputPoolResource>
override this.Update : Azure.WaitUntil * Azure.ResourceManager.CosmosDB.Models.CosmosDBThroughputPoolPatch * System.Threading.CancellationToken -> Azure.ResourceManager.ArmOperation<Azure.ResourceManager.CosmosDB.CosmosDBThroughputPoolResource>
Public Overridable Function Update (waitUntil As WaitUntil, patch As CosmosDBThroughputPoolPatch, Optional cancellationToken As CancellationToken = Nothing) As 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.

patch
CosmosDBThroughputPoolPatch

The parameters to provide for the current Throughput Pool.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

patch is null.

Applies to