MongoClusterResource.Update Method

Definition

Updates an existing mongo cluster. The request body can contain one to many of the properties present in the normal mongo cluster definition.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/mongoClusters/{mongoClusterName}
  • Operation Id: MongoClusters_Update
  • Default Api Version: 2024-07-01
  • Resource: MongoClusterResource
public virtual Azure.ResourceManager.ArmOperation<Azure.ResourceManager.MongoCluster.MongoClusterResource> Update (Azure.WaitUntil waitUntil, Azure.ResourceManager.MongoCluster.Models.MongoClusterPatch patch, System.Threading.CancellationToken cancellationToken = default);
abstract member Update : Azure.WaitUntil * Azure.ResourceManager.MongoCluster.Models.MongoClusterPatch * System.Threading.CancellationToken -> Azure.ResourceManager.ArmOperation<Azure.ResourceManager.MongoCluster.MongoClusterResource>
override this.Update : Azure.WaitUntil * Azure.ResourceManager.MongoCluster.Models.MongoClusterPatch * System.Threading.CancellationToken -> Azure.ResourceManager.ArmOperation<Azure.ResourceManager.MongoCluster.MongoClusterResource>
Public Overridable Function Update (waitUntil As WaitUntil, patch As MongoClusterPatch, Optional cancellationToken As CancellationToken = Nothing) As ArmOperation(Of MongoClusterResource)

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
MongoClusterPatch

The resource properties to be updated.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

patch is null.

Applies to