CosmosDBForPostgreSqlClusterResource.UpdateAsync Method

Definition

Updates an existing cluster. The request body can contain one or several properties from the cluster definition.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}
  • Operation Id: Clusters_Update
public virtual System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.CosmosDBForPostgreSql.CosmosDBForPostgreSqlClusterResource>> UpdateAsync (Azure.WaitUntil waitUntil, Azure.ResourceManager.CosmosDBForPostgreSql.Models.CosmosDBForPostgreSqlClusterPatch patch, System.Threading.CancellationToken cancellationToken = default);
abstract member UpdateAsync : Azure.WaitUntil * Azure.ResourceManager.CosmosDBForPostgreSql.Models.CosmosDBForPostgreSqlClusterPatch * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.CosmosDBForPostgreSql.CosmosDBForPostgreSqlClusterResource>>
override this.UpdateAsync : Azure.WaitUntil * Azure.ResourceManager.CosmosDBForPostgreSql.Models.CosmosDBForPostgreSqlClusterPatch * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.CosmosDBForPostgreSql.CosmosDBForPostgreSqlClusterResource>>
Public Overridable Function UpdateAsync (waitUntil As WaitUntil, patch As CosmosDBForPostgreSqlClusterPatch, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ArmOperation(Of CosmosDBForPostgreSqlClusterResource))

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
CosmosDBForPostgreSqlClusterPatch

The parameters for updating a cluster.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

patch is null.

Applies to