CosmosDBAccountResource.GetMongoDBRoleDefinition Method

Definition

Namespace:

Azure.ResourceManager.CosmosDB

Assembly:

Azure.ResourceManager.CosmosDB.dll

Package:

Azure.ResourceManager.CosmosDB v1.3.2

Source:

CosmosDBAccountResource.cs

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-09-01-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

Response<MongoDBRoleDefinitionResource>

Exceptions

ArgumentNullException

mongoRoleDefinitionId is null.

ArgumentException

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