Share via


MongoDBUserDefinitionCollection.Get(String, CancellationToken) 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-02-15-preview
  • Resource: MongoDBUserDefinitionResource
public virtual Azure.Response<Azure.ResourceManager.CosmosDB.MongoDBUserDefinitionResource> Get (string mongoUserDefinitionId, System.Threading.CancellationToken cancellationToken = default);
abstract member Get : string * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.CosmosDB.MongoDBUserDefinitionResource>
override this.Get : string * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.CosmosDB.MongoDBUserDefinitionResource>
Public Overridable Function Get (mongoUserDefinitionId As String, Optional cancellationToken As CancellationToken = Nothing) As 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 an empty string, and was expected to be non-empty.

mongoUserDefinitionId is null.

Applies to