Sdílet prostřednictvím


CosmosDBAccountResource.GetMongoDBUserDefinitionAsync Method

Definition

Retrieves the properties of an existing Azure Cosmos DB Mongo User Definition with the given Id.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbUserDefinitions/{mongoUserDefinitionId}
  • Operation Id: MongoDBResources_GetMongoUserDefinition
  • Default Api Version: 2024-05-15-preview
  • Resource: MongoDBUserDefinitionResource
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.CosmosDB.MongoDBUserDefinitionResource>> GetMongoDBUserDefinitionAsync (string mongoUserDefinitionId, System.Threading.CancellationToken cancellationToken = default);
abstract member GetMongoDBUserDefinitionAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.CosmosDB.MongoDBUserDefinitionResource>>
override this.GetMongoDBUserDefinitionAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.CosmosDB.MongoDBUserDefinitionResource>>
Public Overridable Function GetMongoDBUserDefinitionAsync (mongoUserDefinitionId As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of MongoDBUserDefinitionResource))

Parameters

mongoUserDefinitionId
String

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

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

mongoUserDefinitionId is null.

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

Applies to