MongoDBUserDefinitionCollection.CreateOrUpdate Method

Definition

Creates or updates an Azure Cosmos DB Mongo User Definition.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbUserDefinitions/{mongoUserDefinitionId}
  • Operation Id: MongoDBResources_CreateUpdateMongoUserDefinition
  • Default Api Version: 2024-09-01-preview
  • Resource: MongoDBUserDefinitionResource
public virtual Azure.ResourceManager.ArmOperation<Azure.ResourceManager.CosmosDB.MongoDBUserDefinitionResource> CreateOrUpdate (Azure.WaitUntil waitUntil, string mongoUserDefinitionId, Azure.ResourceManager.CosmosDB.Models.MongoDBUserDefinitionCreateOrUpdateContent content, System.Threading.CancellationToken cancellationToken = default);
abstract member CreateOrUpdate : Azure.WaitUntil * string * Azure.ResourceManager.CosmosDB.Models.MongoDBUserDefinitionCreateOrUpdateContent * System.Threading.CancellationToken -> Azure.ResourceManager.ArmOperation<Azure.ResourceManager.CosmosDB.MongoDBUserDefinitionResource>
override this.CreateOrUpdate : Azure.WaitUntil * string * Azure.ResourceManager.CosmosDB.Models.MongoDBUserDefinitionCreateOrUpdateContent * System.Threading.CancellationToken -> Azure.ResourceManager.ArmOperation<Azure.ResourceManager.CosmosDB.MongoDBUserDefinitionResource>
Public Overridable Function CreateOrUpdate (waitUntil As WaitUntil, mongoUserDefinitionId As String, content As MongoDBUserDefinitionCreateOrUpdateContent, Optional cancellationToken As CancellationToken = Nothing) As ArmOperation(Of MongoDBUserDefinitionResource)

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.

mongoUserDefinitionId
String

The ID for the User Definition {dbName.userName}.

content
MongoDBUserDefinitionCreateOrUpdateContent

The properties required to create or update a User Definition.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

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

mongoUserDefinitionId or content is null.

Applies to