CosmosDBAccountResource.GetCosmosDBSqlRoleAssignment Method

Definition

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

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

Parameters

roleAssignmentId
String

The GUID for the Role Assignment.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

roleAssignmentId is null.

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

Applies to