Microsoft Azure Kusto Management Client Library for Python

3.4.0 · active · verified Tue Apr 14

The `azure-mgmt-kusto` library is the Microsoft Azure Kusto Management Client Library for Python, used to programmatically manage Azure Kusto (Azure Data Explorer) clusters and databases. It enables operations such as creating, updating, and deleting Kusto clusters and their associated databases. The library follows the modern Azure SDK guidelines and requires Python 3.8 or later. The current version is 3.4.0, released on 2024-01-24.

Warnings

breaking The credential system was completely revamped in versions around 1.0.0b1/3.0.0. Old `azure.common.credentials` or `msrestazure.azure_active_directory` instances are no longer supported. Use classes from `azure-identity` (e.g., `DefaultAzureCredential`). The client constructor parameter `credentials` was renamed to `credential`.
Fix: Install `azure-identity` (`pip install azure-identity`) and update your authentication code to use `DefaultAzureCredential` or other `azure-identity` classes. Change `credentials=` to `credential=` when instantiating the client.
breaking Import paths for the client and model classes changed significantly with versions around 1.0.0b1/3.0.0. `KustoManagementClient` can no longer be imported from `azure.mgmt.kusto.kusto_management_client`. Similarly, models cannot be imported via direct attribute access like `azure.mgmt.kusto.models.my_class`.
Fix: Import `KustoManagementClient` directly from the top-level package: `from azure.mgmt.kusto import KustoManagementClient`. Import model classes from the `azure.mgmt.kusto.models` submodule: `from azure.mgmt.kusto.models import Cluster`.
breaking Operations that used to return a `msrest.polling.LROPoller` now return `azure.core.polling.LROPoller` and are typically prefixed with `begin_`. The exception hierarchy has also been simplified, with most exceptions now being `azure.core.exceptions.HttpResponseError` (the `CloudError` class has been removed).
Fix: Adjust code to use the `begin_` prefix for long-running operations and handle `azure.core.exceptions.HttpResponseError` for general API errors.
gotcha Support for Python 2.7 for Azure SDK Python packages ended on January 1, 2022. This library, `azure-mgmt-kusto`, requires Python 3.8 or newer.
Fix: Ensure your development and deployment environments use Python 3.8 or a later version.
gotcha For `DefaultAzureCredential` to authenticate correctly outside of Azure-hosted environments (like local development without Managed Identity), specific environment variables must be configured: `AZURE_CLIENT_ID`, `AZURE_TENANT_ID`, `AZURE_CLIENT_SECRET` for service principal authentication, and `AZURE_SUBSCRIPTION_ID` for the client to target a subscription.
Fix: Set the required environment variables: `AZURE_CLIENT_ID`, `AZURE_TENANT_ID`, `AZURE_CLIENT_SECRET`, and `AZURE_SUBSCRIPTION_ID`. Refer to the `azure-identity` documentation for alternative authentication flows (e.g., Azure CLI, Managed Identity).

Install

pip install azure-mgmt-kusto azure-identity Install core and authentication libraries

Imports

KustoManagementClient
```
from azure.mgmt.kusto import KustoManagementClient
```
The direct import path for KustoManagementClient changed in breaking versions (e.g., v3.0.0) for consistency with new SDK guidelines.
models
```
from azure.mgmt.kusto.models import Cluster
```
Model imports should use 'from azure.mgmt.kusto.models import ...' rather than direct attribute access on the models module.

Quickstart

This quickstart demonstrates how to authenticate with `DefaultAzureCredential` and instantiate the `KustoManagementClient`. It then shows how to list Kusto clusters within a specified resource group. Ensure that the required environment variables (`AZURE_SUBSCRIPTION_ID`, and optionally `AZURE_CLIENT_ID`, `AZURE_TENANT_ID`, `AZURE_CLIENT_SECRET`, `KUSTO_RESOURCE_GROUP_NAME`) are set for successful execution.

import os
from azure.identity import DefaultAzureCredential
from azure.mgmt.kusto import KustoManagementClient

# Set environment variables for authentication and subscription ID
# AZURE_CLIENT_ID, AZURE_TENANT_ID, AZURE_CLIENT_SECRET (for service principal)
# AZURE_SUBSCRIPTION_ID

subscription_id = os.environ.get("AZURE_SUBSCRIPTION_ID", "YOUR_SUBSCRIPTION_ID")
if not subscription_id or subscription_id == "YOUR_SUBSCRIPTION_ID":
    raise ValueError("AZURE_SUBSCRIPTION_ID environment variable not set or is a placeholder.")

# Authenticate using DefaultAzureCredential. This credential will attempt
# to use various authentication methods, such as environment variables,
# managed identity, or Azure CLI, in a prioritized order.
credential = DefaultAzureCredential()

# Create Kusto Management Client
client = KustoManagementClient(credential=credential, subscription_id=subscription_id)

# Example: List Kusto Clusters in a resource group
# Replace 'YOUR_RESOURCE_GROUP' with an actual resource group name where Kusto clusters exist.
resource_group_name = os.environ.get("KUSTO_RESOURCE_GROUP_NAME", "YOUR_RESOURCE_GROUP")

if not resource_group_name or resource_group_name == "YOUR_RESOURCE_GROUP":
    print("Warning: KUSTO_RESOURCE_GROUP_NAME environment variable not set or is a placeholder. Skipping cluster listing example.")
else:
    print(f"Listing Kusto clusters in resource group: {resource_group_name}")
    try:
        for cluster in client.clusters.list_by_resource_group(resource_group_name):
            print(f"- {cluster.name} (Location: {cluster.location}, SKU: {cluster.sku.name})")
    except Exception as e:
        print(f"Error listing clusters: {e}. Ensure the resource group exists and you have permissions.")

view raw JSON →