Create an Event Hubs data connection for Azure Data Explorer with SDKs

1. Install the Microsoft.Azure.Management.Kusto NuGet package.

2. Create a Microsoft Entra application principal to use for authentication. You need the directory (tenant) ID, application ID, and client secret.

3. Run the following code.

   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 and database that are 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 dataConnections = database.GetKustoDataConnections();
   var eventHubConnectionName = "myeventhubconnect";
   //The event hub that is created as part of the Prerequisites
   var eventHubResourceId = new ResourceIdentifier("/subscriptions/<eventHubSubscriptionId>/resourceGroups/<eventHubResourceGroupName>/providers/Microsoft.EventHub/namespaces/<eventHubNamespaceName>/eventhubs/<eventHubName>");
   var consumerGroup = "$Default";
   var location = AzureLocation.chinaeast2;
   //The table and column mapping are created as part of the Prerequisites
   var tableName = "StormEvents";
   var mappingRuleName = "StormEvents_CSV_Mapping";
   var dataFormat = KustoEventHubDataFormat.Csv;
   var compression = EventHubMessagesCompressionType.None;
   var databaseRouting = KustoDatabaseRouting.Multi;
   var eventHubConnectionData = new KustoEventHubDataConnection
   {
       EventHubResourceId = eventHubResourceId, ConsumerGroup = consumerGroup,
       Location = location, TableName = tableName, MappingRuleName = mappingRuleName,
       DataFormat = dataFormat, Compression = compression, DatabaseRouting = databaseRouting
   };
   await dataConnections.CreateOrUpdateAsync(WaitUntil.Completed, eventHubConnectionName, eventHubConnectionData);
   

   Expand table

   Setting	Suggested value	Field description
   tenantId	xxxxxxxx-xxxxx-xxxx-xxxx-xxxxxxxxx	Your tenant ID. Also known as directory ID.
   subscriptionId	xxxxxxxx-xxxxx-xxxx-xxxx-xxxxxxxxx	The subscription ID that you use for resource creation.
   clientId	xxxxxxxx-xxxxx-xxxx-xxxx-xxxxxxxxx	The client ID of the application that can access resources in your tenant.
   clientSecret	PlaceholderClientSecret	The client secret of the application that can access resources in your tenant.
   resourceGroupName	testrg	The name of the resource group containing your cluster.
   clusterName	mykustocluster	The name of your cluster.
   databaseName	mykustodatabase	The name of the target database in your cluster.
   dataConnectionName	myeventhubconnect	The desired name of your data connection.
   tableName	StormEvents	The name of the target table in the target database.
   mappingRuleName	StormEvents_CSV_Mapping	The name of your column mapping related to the target table.
   dataFormat	csv	The data format of the message.
   eventHubResourceId	Resource ID	The resource ID of your event hub that holds the data for ingestion.
   consumerGroup	$Default	The consumer group of your event hub.
   location	China East 2	The location of the data connection resource.
   compression	gzip or None	The type of data compression.
   databaseRouting	Multi or Single	The database routing for the connection. If you set the value to Single, the data connection is routed to a single database in the cluster as specified in the databaseName setting. If you set the value to Multi, you can override the default target database using the Database ingestion property. For more information, see Events routing.

1. Install the required libraries.

   pip install azure-common
   pip install azure-mgmt-kusto
   

2. Create a Microsoft Entra application principal to use for authentication. You need the directory (tenant) ID, application ID, and client secret.

3. Run the following code.

   from azure.mgmt.kusto import KustoManagementClient
   from azure.mgmt.kusto.models import EventHubDataConnection
   from azure.identity import ClientSecretCredential
   
   #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 = "myresourcegroup"
   #The cluster and database that are created as part of the Prerequisites
   cluster_name = "mycluster"
   database_name = "mydatabase"
   data_connection_name = "myeventhubconnect"
   #The event hub that is created as part of the Prerequisites
   event_hub_resource_id = "/subscriptions/xxxxxxxx-xxxxx-xxxx-xxxx-xxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.EventHub/namespaces/myeventhubnamespace/eventhubs/myeventhub"";
   consumer_group = "$Default"
   location = "China East 2"
   #The table and column mapping that are created as part of the Prerequisites
   table_name = "mytable"
   mapping_rule_name = "mytablemappingrule"
   data_format = "csv"
   database_routing = "Multi"
   #Returns an instance of LROPoller, check https://learn.microsoft.com/python/api/msrest/msrest.polling.lropoller?view=azure-python
   poller = kusto_management_client.data_connections.create_or_update(
               resource_group_name=resource_group_name,
               cluster_name=cluster_name,
               database_name=database_name,
               data_connection_name=data_connection_name,
               parameters=EventHubDataConnection(
                   event_hub_resource_id=event_hub_resource_id,
                   consumer_group=consumer_group,
                   location=location,
                   table_name=table_name,
                   mapping_rule_name=mapping_rule_name,
                   data_format=data_format,
                   database_routing=database_routing
               )
           )
   poller.wait()
   print(poller.result())
   

   Expand table

   Setting	Suggested value	Field description
   tenant_id	xxxxxxxx-xxxxx-xxxx-xxxx-xxxxxxxxx	Your tenant ID. Also known as directory ID.
   subscriptionId	xxxxxxxx-xxxxx-xxxx-xxxx-xxxxxxxxx	The subscription ID that you use for resource creation.
   client_id	xxxxxxxx-xxxxx-xxxx-xxxx-xxxxxxxxx	The client ID of the application that can access resources in your tenant.
   client_secret	xxxxxxxxxxxxxx	The client secret of the application that can access resources in your tenant.
   resource_group_name	myresourcegroup	The name of the resource group containing your cluster.
   cluster_name	mycluster	The name of your cluster.
   database_name	mydatabase	The name of the target database in your cluster.
   data_connection_name	myeventhubconnect	The desired name of your data connection.
   table_name	mytable	The name of the target table in the target database.
   mapping_rule_name	mytablemappingrule	The name of your column mapping related to the target table.
   data_format	csv	The data format of the message.
   event_hub_resource_id	Resource ID	The resource ID of your event hub that holds the data for ingestion.
   consumer_group	$Default	The consumer group of your event hub.
   location	China East 2	The location of the data connection resource.
   databaseRouting	Multi or Single	The database routing for the connection. If you set the value to Single, the data connection is routed to a single database in the cluster as specified in the databaseName setting. If you set the value to Multi, you can override the default target database using the Database ingestion property. For more information, see Events routing.

To remove the event hub connection, run the following command:

kustoManagementClient.DataConnections.Delete(resourceGroupName, clusterName, databaseName, dataConnectionName);

To remove the event hub connection, run the following command:

kusto_management_client.data_connections.delete(resource_group_name=resource_group_name, cluster_name=kusto_cluster_name, database_name=kusto_database_name, data_connection_name=kusto_data_connection_name)