Share via


CosmosDBThroughputPoolAccountResource.UpdateAsync Method

Definition

Creates or updates an Azure Cosmos DB ThroughputPool account. The "Update" method is preferred when performing updates on an account.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/throughputPools/{throughputPoolName}/throughputPoolAccounts/{throughputPoolAccountName}
  • Operation Id: ThroughputPoolAccount_Create
  • Default Api Version: 2024-09-01-preview
  • Resource: CosmosDBThroughputPoolAccountResource
public virtual System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.CosmosDB.CosmosDBThroughputPoolAccountResource>> UpdateAsync (Azure.WaitUntil waitUntil, Azure.ResourceManager.CosmosDB.CosmosDBThroughputPoolAccountData data, System.Threading.CancellationToken cancellationToken = default);
abstract member UpdateAsync : Azure.WaitUntil * Azure.ResourceManager.CosmosDB.CosmosDBThroughputPoolAccountData * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.CosmosDB.CosmosDBThroughputPoolAccountResource>>
override this.UpdateAsync : Azure.WaitUntil * Azure.ResourceManager.CosmosDB.CosmosDBThroughputPoolAccountData * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.CosmosDB.CosmosDBThroughputPoolAccountResource>>
Public Overridable Function UpdateAsync (waitUntil As WaitUntil, data As CosmosDBThroughputPoolAccountData, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ArmOperation(Of CosmosDBThroughputPoolAccountResource))

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.

data
CosmosDBThroughputPoolAccountData

The parameters to provide for the current ThroughputPoolAccount.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

data is null.

Applies to