MongoClusterUserCollection.CreateOrUpdate Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Creates a new user or updates an existing user on a mongo cluster.
- Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/mongoClusters/{mongoClusterName}/users/{userName}
- Operation Id: User_CreateOrUpdate
- Default Api Version: 2025-09-01
- Resource: MongoClusterUserResource
public virtual Azure.ResourceManager.ArmOperation<Azure.ResourceManager.MongoCluster.MongoClusterUserResource> CreateOrUpdate(Azure.WaitUntil waitUntil, string userName, Azure.ResourceManager.MongoCluster.MongoClusterUserData data, System.Threading.CancellationToken cancellationToken = default);abstract member CreateOrUpdate : Azure.WaitUntil * string * Azure.ResourceManager.MongoCluster.MongoClusterUserData * System.Threading.CancellationToken -> Azure.ResourceManager.ArmOperation<Azure.ResourceManager.MongoCluster.MongoClusterUserResource>
override this.CreateOrUpdate : Azure.WaitUntil * string * Azure.ResourceManager.MongoCluster.MongoClusterUserData * System.Threading.CancellationToken -> Azure.ResourceManager.ArmOperation<Azure.ResourceManager.MongoCluster.MongoClusterUserResource>Public Overridable Function CreateOrUpdate (waitUntil As WaitUntil, userName As String, data As MongoClusterUserData, Optional cancellationToken As CancellationToken = Nothing) As ArmOperation(Of MongoClusterUserResource)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.
- userName
- String
The name of the mongo cluster user.
- data
- MongoClusterUserData
Resource create parameters.
- cancellationToken
- CancellationToken
The cancellation token to use.
Returns
Exceptions
userName is an empty string, and was expected to be non-empty.
userName or data is null.
