MongoClusterUserCollection.GetAsync(String, CancellationToken) Method

Definition

Gets the defintion of a Mongo cluster user.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/mongoClusters/{mongoClusterName}/users/{userName}.
  • Operation Id. : Users_Get.
  • Default Api Version. : 2026-02-01-preview.
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.MongoCluster.MongoClusterUserResource>> GetAsync(string userName, System.Threading.CancellationToken cancellationToken = default);
abstract member GetAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.MongoCluster.MongoClusterUserResource>>
override this.GetAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.MongoCluster.MongoClusterUserResource>>
Public Overridable Function GetAsync (userName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of MongoClusterUserResource))

Parameters

userName
String

The name of the mongo cluster user.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

userName is null.

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

Applies to