CosmosDBAccountResource.UpdateAsync Method

Definition

Updates the properties of an existing Azure Cosmos DB database account.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}
  • Operation Id: DatabaseAccounts_Update
  • Default Api Version: 2024-02-15-preview
  • Resource: CosmosDBAccountResource
public virtual System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.CosmosDB.CosmosDBAccountResource>> UpdateAsync (Azure.WaitUntil waitUntil, Azure.ResourceManager.CosmosDB.Models.CosmosDBAccountPatch patch, System.Threading.CancellationToken cancellationToken = default);
abstract member UpdateAsync : Azure.WaitUntil * Azure.ResourceManager.CosmosDB.Models.CosmosDBAccountPatch * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.CosmosDB.CosmosDBAccountResource>>
override this.UpdateAsync : Azure.WaitUntil * Azure.ResourceManager.CosmosDB.Models.CosmosDBAccountPatch * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.CosmosDB.CosmosDBAccountResource>>
Public Overridable Function UpdateAsync (waitUntil As WaitUntil, patch As CosmosDBAccountPatch, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ArmOperation(Of CosmosDBAccountResource))

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
CosmosDBAccountPatch

The parameters to provide for the current database account.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

patch is null.

Applies to