Share via


CosmosDBThroughputPoolCollection.CreateOrUpdateAsync 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}
  • Operation Id: ThroughputPool_CreateOrUpdate
  • Default Api Version: 2024-09-01-preview
  • Resource: CosmosDBThroughputPoolResource
public virtual System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.CosmosDB.CosmosDBThroughputPoolResource>> CreateOrUpdateAsync (Azure.WaitUntil waitUntil, string throughputPoolName, Azure.ResourceManager.CosmosDB.CosmosDBThroughputPoolData data, System.Threading.CancellationToken cancellationToken = default);
abstract member CreateOrUpdateAsync : Azure.WaitUntil * string * Azure.ResourceManager.CosmosDB.CosmosDBThroughputPoolData * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.CosmosDB.CosmosDBThroughputPoolResource>>
override this.CreateOrUpdateAsync : Azure.WaitUntil * string * Azure.ResourceManager.CosmosDB.CosmosDBThroughputPoolData * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.CosmosDB.CosmosDBThroughputPoolResource>>
Public Overridable Function CreateOrUpdateAsync (waitUntil As WaitUntil, throughputPoolName As String, data As CosmosDBThroughputPoolData, 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.

throughputPoolName
String

Cosmos DB Throughput Pool name.

data
CosmosDBThroughputPoolData

The parameters to provide for the current ThroughputPool.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

throughputPoolName is an empty string, and was expected to be non-empty.

throughputPoolName or data is null.

Applies to