Language

MongoDBRoleDefinitionCollection.GetIfExistsAsync Method

Definition

Tries to get details for this resource from the service.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbRoleDefinitions/{mongoRoleDefinitionId}.
  • Operation Id. : MongoRoleDefinitionGetResultsOperationGroup_GetMongoRoleDefinition.
  • Default Api Version. : 2026-03-15.
public virtual System.Threading.Tasks.Task<Azure.NullableResponse<Azure.ResourceManager.CosmosDB.MongoDBRoleDefinitionResource>> GetIfExistsAsync(string mongoRoleDefinitionId, System.Threading.CancellationToken cancellationToken = default);
abstract member GetIfExistsAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.NullableResponse<Azure.ResourceManager.CosmosDB.MongoDBRoleDefinitionResource>>
override this.GetIfExistsAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.NullableResponse<Azure.ResourceManager.CosmosDB.MongoDBRoleDefinitionResource>>
Public Overridable Function GetIfExistsAsync (mongoRoleDefinitionId As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of NullableResponse(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