Azure Data Explorerのクラスタープリンシパルを追加する

[アーティクル]
05/04/2023

Azure Data Explorer は、ログと利用統計情報データのための高速で拡張性に優れたデータ探索サービスです。この記事では、C#、Python、または Azure Resource Manager (ARM) テンプレートを使用して、Azure Data Explorerのクラスタープリンシパルを追加する方法について説明します。

前提条件

前提条件は、プリンシパルの追加に使用される方法によって異なります。お好みの方法に関連するタブを選択します。

次の一覧では、C# でクラスタープリンシパルを追加するための前提条件の概要を示します。

Microsoft アカウントまたは Azure Active Directory のユーザー ID。 Azure サブスクリプションは不要です。
Azure Data Explorer クラスターとデータベース。クラスターとデータベースを作成します。
Visual Studio 2022 Community Edition。 Visual Studio のセットアップ中に Azure 開発 を有効にします。
リソースにアクセスできる Azure AD アプリケーションとサービスプリンシパル。 ディレクトリ (テナント) ID、アプリケーション ID、およびクライアントシークレットを保存します。
Microsoft.Azure.Management.kusto と Microsoft.Rest.ClientRuntime.Azure.Authentication をインストールします。

クラスタープリンシパルの追加

次のコードを実行して、クラスタープリンシパルを追加します。

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 = await ApplicationTokenProvider.LoginSilentAsync(tenantId, clientId, clientSecret);
var kustoManagementClient = new KustoManagementClient(credentials) { SubscriptionId = subscriptionId };
var resourceGroupName = "testrg";
//The cluster that is created as part of the Prerequisites
var clusterName = "mykustocluster";
var clusterPrincipalAssignmentName = "mykustoclusterprincipalassignment";
var principalId = "xxxxxxxx-xxxxx-xxxx-xxxx-xxxxxxxxx"; //User email, application ID, or security group name
var role = "AllDatabasesAdmin"; //AllDatabasesAdmin or AllDatabasesViewer
var tenantIdForPrincipal = "xxxxxxxx-xxxxx-xxxx-xxxx-xxxxxxxxx";
var principalType = "App"; //User, App, or Group
var clusterPrincipalAssignmentData = new ClusterPrincipalAssignment(
    principalId: principalId, role: role, principalType: principalType, tenantId: tenantIdForPrincipal
);
await kustoManagementClient.ClusterPrincipalAssignments.CreateOrUpdateAsync(
    resourceGroupName, clusterName, clusterPrincipalAssignmentName, clusterPrincipalAssignmentData
);

設定	推奨値	フィールドの説明
tenantId	xxxxxxxx-xxxxx-xxxx-xxxx-xxxxxxxxx	テナント ID。ディレクトリ ID とも呼ばれます。
subscriptionId	xxxxxxxx-xxxxx-xxxx-xxxx-xxxxxxxxx	リソースの作成に使用するサブスクリプション ID。
clientId	xxxxxxxx-xxxxx-xxxx-xxxx-xxxxxxxxx	ご利用のテナント内のリソースにアクセスできるアプリケーションのクライアント ID。
clientSecret	PlaceholderClientSecret	ご利用のテナント内のリソースにアクセスできるアプリケーションのクライアントシークレット。
resourceGroupName	testrg	ご利用のクラスターを含むリソースグループの名前。
clusterName	mykustocluster	ご利用のクラスターの名前。
principalAssignmentName	clusterPrincipalAssignment1	クラスタープリンシパルリソースの名前。
principalId	xxxxxxxx-xxxxx-xxxx-xxxx-xxxxxxxxx	プリンシパル ID。ユーザーの電子メール、アプリケーション ID、またはセキュリティグループ名を指定できます。
role	AllDatabasesAdmin	クラスタープリンシパルのロール。'AllDatabasesAdmin'、'AllDatabasesMonitor' または 'AllDatabasesViewer' を指定できます。
tenantIdForPrincipal	xxxxxxxx-xxxxx-xxxx-xxxx-xxxxxxxxx	プリンシパルのテナント ID。
principalType	アプリ	プリンシパルの種類。'User'、'App'、または 'Group' を指定できます。

次のコードを実行して、クラスタープリンシパルを追加します。

from azure.mgmt.kusto import KustoManagementClient
from azure.mgmt.kusto.models import ClusterPrincipalAssignment
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 that is created as part of the Prerequisites
cluster_name = "mykustocluster"
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.cluster_principal_assignments.create_or_update(resource_group_name=resource_group_name, cluster_name=cluster_name, principal_assignment_name= principal_assignment_name, parameters=ClusterPrincipalAssignment(principal_id=principal_id, role=role, tenant_id=tenant_id_for_principal, principal_type=principal_type))

設定	推奨値	フィールドの説明
tenant_id	xxxxxxxx-xxxxx-xxxx-xxxx-xxxxxxxxx	テナント ID。ディレクトリ ID とも呼ばれます。
subscription_id	xxxxxxxx-xxxxx-xxxx-xxxx-xxxxxxxxx	リソースの作成に使用するサブスクリプション ID。
client_id	xxxxxxxx-xxxxx-xxxx-xxxx-xxxxxxxxx	ご利用のテナント内のリソースにアクセスできるアプリケーションのクライアント ID。
client_secret	xxxxxxxxxxxxxx	ご利用のテナント内のリソースにアクセスできるアプリケーションのクライアントシークレット。
resource_group_name	testrg	ご利用のクラスターを含むリソースグループの名前。
cluster_name	mykustocluster	ご利用のクラスターの名前。
principal_assignment_name	clusterPrincipalAssignment1	クラスタープリンシパルリソースの名前。
principal_id	xxxxxxxx-xxxxx-xxxx-xxxx-xxxxxxxxx	プリンシパル ID。ユーザーの電子メール、アプリケーション ID、またはセキュリティグループ名を指定できます。
role	AllDatabasesAdmin	クラスタープリンシパルのロール。'AllDatabasesAdmin'、'AllDatabasesMonitor' または 'AllDatabasesViewer' を指定できます。
tenant_id_for_principal	xxxxxxxx-xxxxx-xxxx-xxxx-xxxxxxxxx	プリンシパルのテナント ID。
principal_type	アプリ	プリンシパルの種類。'User'、'App'、または 'Group' を指定できます。

次の例は、クラスタープリンシパルを追加するための Azure Resource Manager テンプレートを示しています。フォームを使用して、Azure portal でテンプレートの編集とデプロイを実行できます。

{
    "$schema": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#",
    "contentVersion": "1.0.0.0",
    "parameters": {
		"clusterPrincipalAssignmentName": {
            "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"
            }
        },
		"principalIdForCluster": {
            "type": "string",
            "metadata": {
                "description": "Specifies the principal id. It can be user email, application (client) ID, security group name"
            }
        },
		"roleForClusterPrincipal": {
            "type": "string",
			"defaultValue": "AllDatabasesViewer",
            "metadata": {
                "description": "Specifies the cluster principal role. It can be 'AllDatabasesAdmin', 'AllDatabasesMonitor' or 'AllDatabasesViewer'"
            }
        },
		"tenantIdForClusterPrincipal": {
            "type": "string",
            "metadata": {
                "description": "Specifies the tenantId of the principal"
            }
        },
		"principalTypeForCluster": {
            "type": "string",
			"defaultValue": "User",
            "metadata": {
                "description": "Specifies the principal type. It can be 'User', 'App', 'Group'"
            }
        }
    },
    "variables": {
    },
    "resources": [{
            "type": "Microsoft.Kusto/Clusters/principalAssignments",
            "apiVersion": "2019-11-09",
            "name": "[concat(parameters('clusterName'), '/', parameters('clusterPrincipalAssignmentName'))]",
            "properties": {
                "principalId": "[parameters('principalIdForCluster')]",
                "role": "[parameters('roleForClusterPrincipal')]",
				"tenantId": "[parameters('tenantIdForClusterPrincipal')]",
				"principalType": "[parameters('principalTypeForCluster')]"
            }
        }
    ]
}

次のステップ

データベースプリンシパルを追加する

次の方法で共有

Azure Data Explorerのクラスタープリンシパルを追加する

前提条件

クラスタープリンシパルの追加

次のステップ

その他のリソース

次の方法で共有

Azure Data Explorerのクラスター プリンシパルを追加する

前提条件

クラスター プリンシパルの追加

次のステップ

その他のリソース

Azure Data Explorerのクラスタープリンシパルを追加する

クラスタープリンシパルの追加