MongoDBCollectionCollection.CreateOrUpdate Method

Definition

Create or update an Azure Cosmos DB MongoDB Collection

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections/{collectionName}
  • Operation Id: MongoDBResources_CreateUpdateMongoDBCollection
  • Default Api Version: 2024-05-15-preview
  • Resource: MongoDBCollectionResource
public virtual Azure.ResourceManager.ArmOperation<Azure.ResourceManager.CosmosDB.MongoDBCollectionResource> CreateOrUpdate (Azure.WaitUntil waitUntil, string collectionName, Azure.ResourceManager.CosmosDB.Models.MongoDBCollectionCreateOrUpdateContent content, System.Threading.CancellationToken cancellationToken = default);
abstract member CreateOrUpdate : Azure.WaitUntil * string * Azure.ResourceManager.CosmosDB.Models.MongoDBCollectionCreateOrUpdateContent * System.Threading.CancellationToken -> Azure.ResourceManager.ArmOperation<Azure.ResourceManager.CosmosDB.MongoDBCollectionResource>
override this.CreateOrUpdate : Azure.WaitUntil * string * Azure.ResourceManager.CosmosDB.Models.MongoDBCollectionCreateOrUpdateContent * System.Threading.CancellationToken -> Azure.ResourceManager.ArmOperation<Azure.ResourceManager.CosmosDB.MongoDBCollectionResource>
Public Overridable Function CreateOrUpdate (waitUntil As WaitUntil, collectionName As String, content As MongoDBCollectionCreateOrUpdateContent, Optional cancellationToken As CancellationToken = Nothing) As ArmOperation(Of MongoDBCollectionResource)

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.

collectionName
String

Cosmos DB collection name.

content
MongoDBCollectionCreateOrUpdateContent

The parameters to provide for the current MongoDB Collection.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

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

collectionName or content is null.

Applies to