Database-principals toevoegen voor Azure Data Explorer

Azure Data Explorer is een snelle en zeer schaalbare service voor gegevensverkenning voor telemetrische gegevens en gegevens uit logboeken. In dit artikel leert u hoe u database-principals voor Azure Data Explorer toevoegt met behulp van C#, Python of een ARM-sjabloon (Azure Resource Manager).

Vereisten

De vereisten variëren op basis van de methode die wordt gebruikt om de principal toe te voegen. Kies het relevante tabblad voor de gewenste methode.

C#

De volgende lijst bevat een overzicht van de vereisten voor het toevoegen van een clusterprincipal met C#.

• Een Microsoft-account of een Microsoft Entra gebruikersidentiteit. Er is geen Azure-abonnement vereist.
• Een Azure Data Explorer-cluster en -database. Maak een cluster en database.
• Visual Studio 2022 Community Edition. Schakel Azure-ontwikkeling in tijdens de installatie van Visual Studio.
• Een Microsoft Entra toepassing en service-principal die toegang hebben tot resources. Sla de map-id (tenant),de toepassings-id en het clientgeheim op.
• Installeer Azure.ResourceManager.Kusto.
• Installeer het Azure.Identity NuGet-pakket voor verificatie.

Python

De volgende lijst bevat een overzicht van de vereisten voor het toevoegen van een clusterprincipal met Python.

• Een Microsoft-account of een Microsoft Entra gebruikersidentiteit. Er is geen Azure-abonnement vereist.
• Een Azure Data Explorer-cluster en -database. Maak een cluster en database.
• Een Microsoft Entra toepassing en service-principal die toegang hebben tot resources. Sla de map-id (tenant),de toepassings-id en het clientgeheim op.
• Installeer de pakketten azure-common en azure-mgmt-kusto .

ARM

De volgende lijst bevat een overzicht van de vereisten voor het toevoegen van een clusterprincipal met een ARM-sjabloon.

• Een Azure-abonnement. Maak een gratis Azure-account.
• Een Azure Data Explorer-cluster en -database. Maak een cluster en database.

Een database-principal toevoegen

C#

Voer de volgende code uit om een database-principal toe te voegen:

var tenantId = "xxxxxxxx-xxxxx-xxxx-xxxx-xxxxxxxxx"; //Directory (tenant) ID
var clientId = "xxxxxxxx-xxxxx-xxxx-xxxx-xxxxxxxxx"; //Application ID
var clientSecret = "PlaceholderClientSecret"; //Client Secret
var subscriptionId = "xxxxxxxx-xxxxx-xxxx-xxxx-xxxxxxxxx";
var credentials = new ClientSecretCredential(tenantId, clientId, clientSecret);
var resourceManagementClient = new ArmClient(credentials, subscriptionId);
var resourceGroupName = "testrg";
//The cluster that is created as part of the Prerequisites
var clusterName = "mykustocluster";
var databaseName = "mykustodatabase";
var subscription = await resourceManagementClient.GetDefaultSubscriptionAsync();
var resourceGroup = (await subscription.GetResourceGroupAsync(resourceGroupName)).Value;
var cluster = (await resourceGroup.GetKustoClusterAsync(clusterName)).Value;
var database = (await cluster.GetKustoDatabaseAsync(databaseName)).Value;
var databasePrincipalAssignments = database.GetKustoDatabasePrincipalAssignments();
var databasePrincipalAssignmentName = "mykustodatabaseprincipalassignment";
var principalId = "xxxxxxxx-xxxxx-xxxx-xxxx-xxxxxxxxx"; //User email, application ID, or security group name
var role = KustoDatabasePrincipalRole.Admin; //Admin, Ingestor, Monitor, User, UnrestrictedViewers, Viewer
var tenantIdForPrincipal = new Guid("xxxxxxxx-xxxxx-xxxx-xxxx-xxxxxxxxx");
var principalType = KustoPrincipalAssignmentType.App; //User, App, or Group
var databasePrincipalAssignmentData = new KustoDatabasePrincipalAssignmentData
{
    DatabasePrincipalId = principalId, Role = role, PrincipalType = principalType, TenantId = tenantIdForPrincipal
};
await databasePrincipalAssignments.CreateOrUpdateAsync(
    WaitUntil.Completed, databasePrincipalAssignmentName, databasePrincipalAssignmentData
);

Instelling	Voorgestelde waarde	Beschrijving van veld
tenantId	xxxxxxxx-xxxxx-xxxx-xxxx-xxxxxxxxx	Uw tenant-id. Ook wel bekend als map-id.
subscriptionId	xxxxxxxx-xxxxx-xxxx-xxxx-xxxxxxxxx	De abonnements-id die u gebruikt voor het maken van resources.
clientId	xxxxxxxx-xxxxx-xxxx-xxxx-xxxxxxxxx	De client-id van de toepassing die toegang heeft tot resources in uw tenant.
clientSecret	PlaceholderClientSecret	Het clientgeheim van de toepassing die toegang heeft tot resources in uw tenant.
resourceGroupName	testrg	De naam van de resourcegroep die uw cluster bevat.
clusterName	mykustocluster	De naam van uw cluster.
databaseName	mykustodatabase	De naam van uw database.
databasePrincipalAssignmentName	mykustodatabaseprincipalassignment	De naam van uw database-principalresource.
principalId	xxxxxxxx-xxxxx-xxxx-xxxx-xxxxxxxxx	De principal-id, die het e-mailadres van de gebruiker, de toepassings-id of de naam van de beveiligingsgroep kan zijn.
role	Beheerder	De rol van uw database-principal, die 'Beheer', 'Ingestor', 'Monitor', 'Gebruiker', 'UnrestrictedViewers', 'Viewer' kan zijn.
tenantIdForPrincipal	xxxxxxxx-xxxxx-xxxx-xxxx-xxxxxxxxx	De tenant-id van de principal.
principalType	App	Het type principal, dat 'Gebruiker', 'App' of 'Groep' kan zijn

Python

In het volgende voorbeeld ziet u hoe u programmatisch een database-principal toevoegt.

from azure.mgmt.kusto import KustoManagementClient
from azure.mgmt.kusto.models import DatabasePrincipalAssignment
from azure.common.credentials import ServicePrincipalCredentials

#Directory (tenant) ID
tenant_id = "xxxxxxxx-xxxxx-xxxx-xxxx-xxxxxxxxx"
#Application ID
client_id = "xxxxxxxx-xxxxx-xxxx-xxxx-xxxxxxxxx"
#Client Secret
client_secret = "xxxxxxxxxxxxxx"
subscription_id = "xxxxxxxx-xxxxx-xxxx-xxxx-xxxxxxxxx"
credentials = ServicePrincipalCredentials(
        client_id=client_id,
        secret=client_secret,
        tenant=tenant_id
    )
kusto_management_client = KustoManagementClient(credentials, subscription_id)

resource_group_name = "testrg"
#The cluster and database that is created as part of the Prerequisites
cluster_name = "mykustocluster"
database_name = "mykustodatabase"
principal_assignment_name = "clusterPrincipalAssignment1"
#User email, application ID, or security group name
principal_id = "xxxxxxxx"
#AllDatabasesAdmin, AllDatabasesMonitor or AllDatabasesViewer
role = "AllDatabasesAdmin"
tenant_id_for_principal = tenantId
#User, App, or Group
principal_type = "App"

#Returns an instance of LROPoller, check https://learn.microsoft.com/python/api/msrest/msrest.polling.lropoller?view=azure-python
poller = kusto_management_client.database_principal_assignments.create_or_update(resource_group_name=resource_group_name, cluster_name=cluster_name, database_name=database_name, principal_assignment_name= principal_assignment_name, parameters=DatabasePrincipalAssignment(principal_id=principal_id, role=role, tenant_id=tenant_id_for_principal, principal_type=principal_type))

Instelling	Voorgestelde waarde	Beschrijving van veld
tenant_id	xxxxxxxx-xxxxx-xxxx-xxxx-xxxxxxxxx	Uw tenant-id. Ook wel bekend als map-id.
subscription_id	xxxxxxxx-xxxxx-xxxx-xxxx-xxxxxxxxx	De abonnements-id die u gebruikt voor het maken van resources.
client_id	xxxxxxxx-xxxxx-xxxx-xxxx-xxxxxxxxx	De client-id van de toepassing die toegang heeft tot resources in uw tenant.
client_secret	xxxxxxxxxxxxxxxx	Het clientgeheim van de toepassing die toegang heeft tot resources in uw tenant.
resource_group_name	testrg	De naam van de resourcegroep die uw cluster bevat.
cluster_name	mykustocluster	De naam van uw cluster.
Database_name	mykustodatabase	De naam van uw database.
principal_assignment_name	databasePrincipalAssignment1	De naam van uw database-principalresource.
principal_id	xxxxxxxx-xxxxx-xxxx-xxxx-xxxxxxxxx	De principal-id, die het e-mailadres van de gebruiker, de toepassings-id of de naam van de beveiligingsgroep kan zijn.
role	Beheerder	De rol van uw database-principal, die 'Beheer', 'Ingestor', 'Monitor', 'Gebruiker', 'UnrestrictedViewers', 'Viewer' kan zijn.
tenant_id_for_principal	xxxxxxxx-xxxxx-xxxx-xxxx-xxxxxxxxx	De tenant-id van de principal.
principal_type	App	Het type principal, dat 'Gebruiker', 'App' of 'Groep' kan zijn

ARM-sjabloon

In het volgende voorbeeld ziet u een Azure Resource Manager-sjabloon voor het toevoegen van een database-principal. U kunt de sjabloon bewerken en implementeren in de Azure Portal met behulp van het formulier.

{
    "$schema": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#",
    "contentVersion": "1.0.0.0",
    "parameters": {
		"principalAssignmentName": {
            "type": "string",
            "defaultValue": "principalAssignment1",
            "metadata": {
                "description": "Specifies the name of the principal assignment"
            }
        },
        "clusterName": {
            "type": "string",
            "defaultValue": "mykustocluster",
            "metadata": {
                "description": "Specifies the name of the cluster"
            }
        },
		"databaseName": {
            "type": "string",
            "defaultValue": "mykustodatabase",
            "metadata": {
                "description": "Specifies the name of the database"
            }
        },
		"principalIdForDatabase": {
            "type": "string",
            "metadata": {
                "description": "Specifies the principal id. It can be user email, application (client) ID, security group name"
            }
        },
		"roleForDatabasePrincipal": {
            "type": "string",
			"defaultValue": "Admin",
            "metadata": {
                "description": "Specifies the database principal role. It can be 'Admin', 'Ingestor', 'Monitor', 'User', 'UnrestrictedViewers', 'Viewer'"
            }
        },
		"tenantIdForDatabasePrincipal": {
            "type": "string",
            "metadata": {
                "description": "Specifies the tenantId of the database principal"
            }
        },
		"principalTypeForDatabase": {
            "type": "string",
			"defaultValue": "App",
            "metadata": {
                "description": "Specifies the principal type. It can be 'User', 'App', 'Group'"
            }
        }
    },
    "variables": {
    },
    "resources": [{
            "type": "Microsoft.Kusto/Clusters/Databases/principalAssignments",
            "apiVersion": "2019-11-09",
            "name": "[concat(parameters('clusterName'), '/', parameters('databaseName'), '/', parameters('principalAssignmentName'))]",
            "properties": {
                "principalId": "[parameters('principalIdForDatabase')]",
                "role": "[parameters('roleForDatabasePrincipal')]",
				"tenantId": "[parameters('tenantIdForDatabasePrincipal')]",
				"principalType": "[parameters('principalTypeForDatabase')]"
            }
        }
    ]
}

Gerelateerde inhoud

• Clusterprincipals toevoegen