CosmosDBSqlRoleDefinitionCollection.GetIfExistsAsync Method

Definition

Namespace:

Azure.ResourceManager.CosmosDB

Assembly:

Azure.ResourceManager.CosmosDB.dll

Package:

Azure.ResourceManager.CosmosDB v1.3.2

Source:

CosmosDBSqlRoleDefinitionCollection.cs

Tries to get details for this resource from the service.

• Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlRoleDefinitions/{roleDefinitionId}
• Operation Id: SqlResources_GetSqlRoleDefinition
• Default Api Version: 2024-09-01-preview
• Resource: CosmosDBSqlRoleDefinitionResource

public virtual System.Threading.Tasks.Task<Azure.NullableResponse<Azure.ResourceManager.CosmosDB.CosmosDBSqlRoleDefinitionResource>> GetIfExistsAsync (string roleDefinitionId, System.Threading.CancellationToken cancellationToken = default);

abstract member GetIfExistsAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.NullableResponse<Azure.ResourceManager.CosmosDB.CosmosDBSqlRoleDefinitionResource>>
override this.GetIfExistsAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.NullableResponse<Azure.ResourceManager.CosmosDB.CosmosDBSqlRoleDefinitionResource>>

Public Overridable Function GetIfExistsAsync (roleDefinitionId As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of NullableResponse(Of CosmosDBSqlRoleDefinitionResource))

Parameters

roleDefinitionId

String

The GUID for the Role Definition.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Task<NullableResponse<CosmosDBSqlRoleDefinitionResource>>

Exceptions

ArgumentException

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

ArgumentNullException

roleDefinitionId is null.