CosmosDBAccountResource.GetMongoDBRoleDefinition Method

Definition

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

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

Parameters

mongoRoleDefinitionId
String

The ID for the Role Definition {dbName.roleName}.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

mongoRoleDefinitionId is null.

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

Applies to