Create an Event Hub data connection for Azure Data Explorer by using Python
Azure Data Explorer is a fast and highly scalable data exploration service for log and telemetry data. Azure Data Explorer offers ingestion (data loading) from Event Hubs, IoT Hubs, and blobs written to blob containers.
In this article, you create an Event Hub data connection for Azure Data Explorer by using Python.
- An Azure account with an active subscription. Create an account for free.
- Python 3.4+.
- A cluster and database.
- Table and column mapping.
- Database and table policies (optional).
- Event Hub with data for ingestion.
Install Python package
To install the Python package for Azure Data Explorer (Kusto), open a command prompt that has Python in its path. Run the following command:
pip install azure-common pip install azure-mgmt-kusto
To run the following example, you need an Azure Active Directory (Azure AD) application and service principal that can access resources. To create a free Azure AD application and add role assignment at the subscription level, see Create an Azure AD application. You also need the directory (tenant) ID, application ID, and client secret.
Add an Event Hub data connection
The following example shows you how to add an Event Hub data connection programmatically. See connect to the event hub for adding an Event Hub data connection using the Azure portal.
from azure.mgmt.kusto import KustoManagementClient from azure.mgmt.kusto.models import EventHubDataConnection 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 are created as part of the Prerequisites cluster_name = "mykustocluster" database_name = "mykustodatabase" 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/xxxxxx/providers/Microsoft.EventHub/namespaces/xxxxxx/eventhubs/xxxxxx"; consumer_group = "$Default" location = "Central US" #The table and column mapping that are created as part of the Prerequisites table_name = "StormEvents" mapping_rule_name = "StormEvents_CSV_Mapping" data_format = "csv" #Returns an instance of LROPoller, check https://docs.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))
|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||testrg||The name of the resource group containing your cluster.|
|cluster_name||mykustocluster||The name of your cluster.|
|database_name||mykustodatabase||The name of the target database in your cluster.|
|data_connection_name||myeventhubconnect||The desired name of your data connection.|
|table_name||StormEvents||The name of the target table in the target database.|
|mapping_rule_name||StormEvents_CSV_Mapping||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||Central US||The location of the data connection resource.|
Clean up resources
To delete the data connection, use 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)