CosmosDBAccountResource.GetCosmosDBSqlRoleDefinition 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.11
Source:
CosmosDBAccountResource.cs
Source:
CosmosDBAccountResource.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-09-01-preview
  • Resource: CosmosDBSqlRoleDefinitionResource
public virtual Azure.Response<Azure.ResourceManager.CosmosDB.CosmosDBSqlRoleDefinitionResource> GetCosmosDBSqlRoleDefinition (string roleDefinitionId, System.Threading.CancellationToken cancellationToken = default);
abstract member GetCosmosDBSqlRoleDefinition : string * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.CosmosDB.CosmosDBSqlRoleDefinitionResource>
override this.GetCosmosDBSqlRoleDefinition : string * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.CosmosDB.CosmosDBSqlRoleDefinitionResource>
Public Overridable Function GetCosmosDBSqlRoleDefinition (roleDefinitionId As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of CosmosDBSqlRoleDefinitionResource)

Parameters

roleDefinitionId
String

The GUID for the Role Definition.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Response<CosmosDBSqlRoleDefinitionResource>

Exceptions

ArgumentNullException

roleDefinitionId is null.

ArgumentException

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

Applies to