Databases - List Principals

POST https://management.azure.com/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/clusters/kustoCluster/databases/KustoDatabase8/listPrincipals?api-version=2025-02-14

from azure.identity import DefaultAzureCredential

from azure.mgmt.kusto import KustoManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-kusto
# USAGE
    python kusto_database_list_principals.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 = KustoManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.databases.list_principals(
        resource_group_name="kustorptest",
        cluster_name="kustoCluster",
        database_name="KustoDatabase8",
    )
    for item in response:
        print(item)


# x-ms-original-file: 2025-02-14/KustoDatabaseListPrincipals.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 armkusto_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/kusto/armkusto/v2"
)

// Generated from example definition: 2025-02-14/KustoDatabaseListPrincipals.json
func ExampleDatabasesClient_NewListPrincipalsPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armkusto.NewClientFactory("12345678-1234-1234-1234-123456789098", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewDatabasesClient().NewListPrincipalsPager("kustorptest", "kustoCluster", "KustoDatabase8", 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 = armkusto.DatabasesClientListPrincipalsResponse{
		// 	DatabasePrincipalListResult: armkusto.DatabasePrincipalListResult{
		// 		Value: []*armkusto.DatabasePrincipal{
		// 			{
		// 				Name: to.Ptr("Some User"),
		// 				Type: to.Ptr(armkusto.DatabasePrincipalTypeUser),
		// 				AppID: to.Ptr(""),
		// 				Email: to.Ptr("user@microsoft.com"),
		// 				Fqn: to.Ptr("aaduser=some_guid"),
		// 				Role: to.Ptr(armkusto.DatabasePrincipalRoleAdmin),
		// 			},
		// 			{
		// 				Name: to.Ptr("Kusto"),
		// 				Type: to.Ptr(armkusto.DatabasePrincipalTypeGroup),
		// 				AppID: to.Ptr(""),
		// 				Email: to.Ptr("kusto@microsoft.com"),
		// 				Fqn: to.Ptr("aadgroup=some_guid"),
		// 				Role: to.Ptr(armkusto.DatabasePrincipalRoleViewer),
		// 			},
		// 			{
		// 				Name: to.Ptr("SomeApp"),
		// 				Type: to.Ptr(armkusto.DatabasePrincipalTypeApp),
		// 				AppID: to.Ptr("some_guid_app_id"),
		// 				Email: to.Ptr(""),
		// 				Fqn: to.Ptr("aadapp=some_guid_app_id"),
		// 				Role: to.Ptr(armkusto.DatabasePrincipalRoleAdmin),
		// 			},
		// 		},
		// 	},
		// }
	}
}

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

const { KustoManagementClient } = require("@azure/arm-kusto");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to returns a list of database principals of the given Kusto cluster and database.
 *
 * @summary returns a list of database principals of the given Kusto cluster and database.
 * x-ms-original-file: 2025-02-14/KustoDatabaseListPrincipals.json
 */
async function kustoDatabaseListPrincipals() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "12345678-1234-1234-1234-123456789098";
  const client = new KustoManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.databases.listPrincipals(
    "kustorptest",
    "kustoCluster",
    "KustoDatabase8",
  )) {
    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