CosmosDBThroughputPoolAccountCollection.CreateOrUpdate 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-05-15-preview
  • Resource: CosmosDBThroughputPoolAccountResource
public virtual Azure.ResourceManager.ArmOperation<Azure.ResourceManager.CosmosDB.CosmosDBThroughputPoolAccountResource> CreateOrUpdate (Azure.WaitUntil waitUntil, string throughputPoolAccountName, Azure.ResourceManager.CosmosDB.CosmosDBThroughputPoolAccountData data, System.Threading.CancellationToken cancellationToken = default);
abstract member CreateOrUpdate : Azure.WaitUntil * string * Azure.ResourceManager.CosmosDB.CosmosDBThroughputPoolAccountData * System.Threading.CancellationToken -> Azure.ResourceManager.ArmOperation<Azure.ResourceManager.CosmosDB.CosmosDBThroughputPoolAccountResource>
override this.CreateOrUpdate : Azure.WaitUntil * string * Azure.ResourceManager.CosmosDB.CosmosDBThroughputPoolAccountData * System.Threading.CancellationToken -> Azure.ResourceManager.ArmOperation<Azure.ResourceManager.CosmosDB.CosmosDBThroughputPoolAccountResource>
Public Overridable Function CreateOrUpdate (waitUntil As WaitUntil, throughputPoolAccountName As String, data As CosmosDBThroughputPoolAccountData, Optional cancellationToken As CancellationToken = Nothing) As 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.

throughputPoolAccountName
String

Cosmos DB global database account in a Throughput Pool.

data
CosmosDBThroughputPoolAccountData

The parameters to provide for the current ThroughputPoolAccount.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

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

throughputPoolAccountName or data is null.

Applies to