SqlResources2 - List Sql Role Definitions

Servizio:: Cosmos DB Resource Provider

Versione API:: 2025-04-15

Recupera l'elenco di tutte le definizioni di ruolo SQL di Azure Cosmos DB.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlRoleDefinitions?api-version=2025-04-15

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
accountName	path	True	string minLength: 3 maxLength: 50 pattern: ^[a-z0-9]+(-[a-z0-9]+)*	Nome dell'account del database Cosmos DB.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nome del gruppo di risorse. Il nome è insensibile alle maiuscole e minuscole.
subscriptionId	path	True	string minLength: 1	ID della sottoscrizione di destinazione.
api-version	query	True	string minLength: 1	Versione dell'API da usare per questa operazione.

Risposte

Nome	Tipo	Descrizione
200 OK	SqlRoleDefinitionListResult	Operazione di elenco completata correttamente.
Other Status Codes	CloudError	Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	Impersonare l'account utente

Esempio

CosmosDBSqlRoleDefinitionList

Esempio di richiesta

GET https://management.azure.com/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/sqlRoleDefinitions?api-version=2025-04-15


/**
 * Samples for SqlResources ListSqlRoleDefinitions.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2025-04-15/examples/
     * CosmosDBSqlRoleDefinitionList.json
     */
    /**
     * Sample code: CosmosDBSqlRoleDefinitionList.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void cosmosDBSqlRoleDefinitionList(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.cosmosDBAccounts().manager().serviceClient().getSqlResources()
            .listSqlRoleDefinitions("myResourceGroupName", "myAccountName", com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential

from azure.mgmt.cosmosdb import CosmosDBManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-cosmosdb
# USAGE
    python cosmos_db_sql_role_definition_list.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = CosmosDBManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="mySubscriptionId",
    )

    response = client.sql_resources.list_sql_role_definitions(
        resource_group_name="myResourceGroupName",
        account_name="myAccountName",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2025-04-15/examples/CosmosDBSqlRoleDefinitionList.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armcosmos_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/cosmos/armcosmos/v3"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/011ecc5633300a5eefe43dde748f269d39e96458/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2025-04-15/examples/CosmosDBSqlRoleDefinitionList.json
func ExampleSQLResourcesClient_NewListSQLRoleDefinitionsPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcosmos.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewSQLResourcesClient().NewListSQLRoleDefinitionsPager("myResourceGroupName", "myAccountName", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.SQLRoleDefinitionListResult = armcosmos.SQLRoleDefinitionListResult{
		// 	Value: []*armcosmos.SQLRoleDefinitionGetResults{
		// 		{
		// 			Name: to.Ptr("myRoleDefinitionId"),
		// 			Type: to.Ptr("Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions"),
		// 			ID: to.Ptr("/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/sqlRoleDefinitions/myRoleDefinitionId"),
		// 			Properties: &armcosmos.SQLRoleDefinitionResource{
		// 				Type: to.Ptr(armcosmos.RoleDefinitionTypeCustomRole),
		// 				AssignableScopes: []*string{
		// 					to.Ptr("/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/dbs/sales"),
		// 					to.Ptr("/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/dbs/purchases")},
		// 					Permissions: []*armcosmos.Permission{
		// 						{
		// 							DataActions: []*string{
		// 								to.Ptr("Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/items/create"),
		// 								to.Ptr("Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/items/read")},
		// 								NotDataActions: []*string{
		// 								},
		// 						}},
		// 						RoleName: to.Ptr("myRoleName"),
		// 					},
		// 			}},
		// 		}
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { CosmosDBManagementClient } = require("@azure/arm-cosmosdb");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Retrieves the list of all Azure Cosmos DB SQL Role Definitions.
 *
 * @summary Retrieves the list of all Azure Cosmos DB SQL Role Definitions.
 * x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2025-04-15/examples/CosmosDBSqlRoleDefinitionList.json
 */
async function cosmosDbSqlRoleDefinitionList() {
  const subscriptionId = process.env["COSMOSDB_SUBSCRIPTION_ID"] || "mySubscriptionId";
  const resourceGroupName = process.env["COSMOSDB_RESOURCE_GROUP"] || "myResourceGroupName";
  const accountName = "myAccountName";
  const credential = new DefaultAzureCredential();
  const client = new CosmosDBManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.sqlResources.listSqlRoleDefinitions(
    resourceGroupName,
    accountName,
  )) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Risposta di esempio

Codice di stato:: 200

{
  "value": [
    {
      "id": "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/sqlRoleDefinitions/myRoleDefinitionId",
      "name": "myRoleDefinitionId",
      "type": "Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions",
      "properties": {
        "roleName": "myRoleName",
        "type": "CustomRole",
        "assignableScopes": [
          "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/dbs/sales",
          "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/dbs/purchases"
        ],
        "permissions": [
          {
            "dataActions": [
              "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/items/create",
              "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/items/read"
            ],
            "notDataActions": []
          }
        ]
      }
    }
  ]
}

Definizioni

Nome	Descrizione
CloudError	Risposta di errore dal servizio.
ErrorResponse	Risposta errore.
Permission	Set di operazioni del piano dati consentite tramite questa definizione di ruolo.
RoleDefinitionType	Indica se la definizione del ruolo è stata creata o creata dall'utente.
SqlRoleDefinitionGetResults	Definizione di ruolo SQL di Azure Cosmos DB.
SqlRoleDefinitionListResult	Definizioni di ruolo pertinenti.

CloudError

Object

Risposta di errore dal servizio.

Nome	Tipo	Descrizione
error	ErrorResponse	Risposta errore.

ErrorResponse

Object

Risposta errore.

Nome	Tipo	Descrizione
code	string	Codice di errore.
message	string	Messaggio di errore che indica il motivo per cui l'operazione non è riuscita.

Permission

Object

Set di operazioni del piano dati consentite tramite questa definizione di ruolo.

Nome	Tipo	Descrizione
dataActions	string[]	Matrice di azioni dati consentite.
notDataActions	string[]	Matrice di azioni di dati negate.

RoleDefinitionType

Enumerazione

Indica se la definizione del ruolo è stata creata o creata dall'utente.

Valore	Descrizione
BuiltInRole
CustomRole

SqlRoleDefinitionGetResults

Object

Definizione di ruolo SQL di Azure Cosmos DB.

Nome	Tipo	Descrizione
id	string	Identificatore univoco della risorsa dell'account del database.
name	string	Nome dell'account di database.
properties.assignableScopes	string[]	Set di ambiti completi all'indirizzo o al di sotto dei quali è possibile creare assegnazioni di ruolo usando questa definizione di ruolo. Ciò consentirà l'applicazione di questa definizione di ruolo nell'intero account di database o in qualsiasi database/raccolta sottostante. Deve avere almeno un elemento. Gli ambiti superiori all'account di database non sono applicabili come ambiti assegnabili. Si noti che le risorse a cui si fa riferimento negli ambiti assegnabili non devono esistere.
properties.permissions	Permission[]	Set di operazioni consentite tramite questa definizione di ruolo.
properties.roleName	string	Nome descrittivo per la definizione del ruolo. Deve essere univoco per l'account del database.
properties.type	RoleDefinitionType	Indica se la definizione del ruolo è stata creata o creata dall'utente.
type	string	Tipo di risorsa di Azure.

SqlRoleDefinitionListResult

Object

Definizioni di ruolo pertinenti.

Nome	Tipo	Descrizione
value	SqlRoleDefinitionGetResults[]	Elenco delle definizioni di ruolo e delle relative proprietà.

Condividi tramite

SqlResources2 - List Sql Role Definitions

Parametri dell'URI

Risposte

Sicurezza

azure_auth

Ambiti

Esempio

CosmosDBSqlRoleDefinitionList

Esempio di richiesta

Risposta di esempio

Definizioni

CloudError

ErrorResponse

Permission

RoleDefinitionType

SqlRoleDefinitionGetResults

SqlRoleDefinitionListResult