CosmosDBSqlRoleDefinitionCollection.GetAsync 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.10
Source:
CosmosDBSqlRoleDefinitionCollection.cs
Source:
CosmosDBSqlRoleDefinitionCollection.cs

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

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

Parameters

roleDefinitionId
String

The GUID for the Role Definition.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Task<Response<CosmosDBSqlRoleDefinitionResource>>

Exceptions

ArgumentException

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

ArgumentNullException

roleDefinitionId is null.

Applies to