Share via


MongoClusterCollection.CreateOrUpdateAsync Method

Definition

Create or update a mongo cluster. Update overwrites all properties for the resource. To only modify some of the properties, use PATCH.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/mongoClusters/{mongoClusterName}
  • Operation Id: MongoClusters_CreateOrUpdate
  • Default Api Version: 2024-02-15-preview
  • Resource: MongoClusterResource
public virtual System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.CosmosDB.MongoClusterResource>> CreateOrUpdateAsync (Azure.WaitUntil waitUntil, string mongoClusterName, Azure.ResourceManager.CosmosDB.MongoClusterData data, System.Threading.CancellationToken cancellationToken = default);
abstract member CreateOrUpdateAsync : Azure.WaitUntil * string * Azure.ResourceManager.CosmosDB.MongoClusterData * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.CosmosDB.MongoClusterResource>>
override this.CreateOrUpdateAsync : Azure.WaitUntil * string * Azure.ResourceManager.CosmosDB.MongoClusterData * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.CosmosDB.MongoClusterResource>>
Public Overridable Function CreateOrUpdateAsync (waitUntil As WaitUntil, mongoClusterName As String, data As MongoClusterData, Optional cancellationToken As CancellationToken = Nothing) As Task(Of 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.

mongoClusterName
String

The name of the mongo cluster.

data
MongoClusterData

The required parameters for creating or updating a mongo cluster.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

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

mongoClusterName or data is null.

Applies to