MongoDBUserDefinitionCollection.GetAsync(String, CancellationToken) 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.
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. : MongoUserDefinitionGetResultsOperationGroup_GetMongoUserDefinition.
- Default Api Version. : 2026-03-15.
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.CosmosDB.MongoDBUserDefinitionResource>> GetAsync(string mongoUserDefinitionId, System.Threading.CancellationToken cancellationToken = default);abstract member GetAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.CosmosDB.MongoDBUserDefinitionResource>>
override this.GetAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.CosmosDB.MongoDBUserDefinitionResource>>Public Overridable Function GetAsync (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.
