다음을 통해 공유

CosmosDBAccountResource.GetMongoDBUserDefinition Method

  • Reference

Definition

Namespace:
Azure.ResourceManager.CosmosDB
Assembly:
Azure.ResourceManager.CosmosDB.dll
Package:
Azure.ResourceManager.CosmosDB v1.3.2
Package:
Azure.ResourceManager.CosmosDB v1.4.0-beta.11
Source:
CosmosDBAccountResource.cs
Source:
CosmosDBAccountResource.cs

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-09-01-preview
  • Resource: MongoDBUserDefinitionResource
public virtual Azure.Response<Azure.ResourceManager.CosmosDB.MongoDBUserDefinitionResource> GetMongoDBUserDefinition (string mongoUserDefinitionId, System.Threading.CancellationToken cancellationToken = default);
abstract member GetMongoDBUserDefinition : string * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.CosmosDB.MongoDBUserDefinitionResource>
override this.GetMongoDBUserDefinition : string * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.CosmosDB.MongoDBUserDefinitionResource>
Public Overridable Function GetMongoDBUserDefinition (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

Response<MongoDBUserDefinitionResource>

Exceptions

ArgumentNullException

mongoUserDefinitionId is null.

ArgumentException

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

Applies to