CosmosDBAccountResource.GetMongoDBRoleDefinitionAsync 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.8

Source:: CosmosDBAccountResource.cs

Source:: CosmosDBAccountResource.cs

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 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 System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.CosmosDB.MongoDBRoleDefinitionResource>> GetMongoDBRoleDefinitionAsync (string mongoRoleDefinitionId, System.Threading.CancellationToken cancellationToken = default);

abstract member GetMongoDBRoleDefinitionAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.CosmosDB.MongoDBRoleDefinitionResource>>
override this.GetMongoDBRoleDefinitionAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.CosmosDB.MongoDBRoleDefinitionResource>>

Public Overridable Function GetMongoDBRoleDefinitionAsync (mongoRoleDefinitionId As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of MongoDBRoleDefinitionResource))

Parameters

mongoRoleDefinitionId: String

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

cancellationToken: CancellationToken

The cancellation token to use.

Returns

Task<Response<MongoDBRoleDefinitionResource>>

Exceptions

ArgumentNullException

mongoRoleDefinitionId is null.

ArgumentException

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

Applies to