Set up your development environment to use Kusto client libraries

One or more of the following .NET SDK frameworks:

• .NET SDK 5.0 or later
• .NET Core 2.1 or later
• .NET Standard 2.1 or later
• .NET Framework 4.7.2 or later

Verify installation: In a command shell, run dotnet sdk check to check that the versions installed meet the minimum requirements.

• Python 3.7 or later
  • Ensure the python executable is in your PATH
  • Verify installation: In a command shell, run python --version to check that the version is 3.7 or later

• Node 16 or later built with ES6

  • Ensure the node executable is in your PATH
  • Verify installation: In a command shell, run node --version to check that the version is 3.7 or later

• A Node.js app or a browser-based web app, such as a React app.

• For browser-based web apps:

  • If your app has a login experience, you can use the @auzre/identity library to issue an authorization token and use withTokenProvider to feed this token to the Kusto client:

    const tokenProvider =  () => Promise.resolve("someToken")
    KustoConnectionStringBuilder.withTokenProvider(clusterUri, tokenProvider)
    

  • If your app doesn't have a login experience, or you prefer to use the Kusto client library to prompt authentication, you need to set up an application registration with the necessary permissions:

    1. Create a Microsoft Entra application registration.
    2. In the Authentication tab, select + Add a platform. Then, select Single-page application.
    3. Enter the desired Redirect URIs, select the boxes for Access tokens and ID tokens, and select Configure. For more information on redirect URIs, see Desktop app that calls web APIs.
    4. Configure delegated permissions for the application.
    5. Grant the application access to your Azure Data Explorer database.
    6. In the Overview tab, copy the Application (client) ID.

    The examples throughout the following tutorials use the Kusto client library to prompt authentication.

    Note

    If you belong to an organization, restrictions based on organization configurations might prevent you from authenticating. Ask for access from an organization admin or try again on a personal account.

• JDK 8 or later
  • Ensure the java executable is in your PATH
  • Verify installation: In a command shell, run java -version to check that the version is 8 or later
• Maven 3.6.3 or later
  • Ensure the mvn executable is in your PATH
  • Verify installation: In a command shell, run mvn -version to check that the version is 3.6.3 or later

dotnet add package Microsoft.Azure.Kusto.Data --version 11.2.2
dotnet add package Microsoft.Azure.Kusto.Ingest --version 11.2.2

python -m pip install azure-kusto-data
python -m pip install azure-kusto-ingest

npm install azure-kusto-data
npm install azure-kusto-ingest

When creating apps, use the maven-archetype-quickstart Maven template for the package, as follows.

 mvn archetype:generate -DgroupId=com.mycompany.app -DartifactId==my-app -DarchetypeArtifactId=maven-archetype-quickstart -DarchetypeVersion=1.4 -DinteractiveMode=false

Then add the following dependencies to your pom.xml, replacing the artifact versions with the latest available on Maven Central for kusto-data and kusto-ingest.

<dependency>
  <groupId>com.microsoft.azure.kusto</groupId>
  <artifactId>kusto-data</artifactId>
  <version>5.0.0</version>
</dependency>
<dependency>
  <groupId>com.microsoft.azure.kusto</groupId>
  <artifactId>kusto-ingest</artifactId>
  <version>5.0.0</version>
</dependency>

You also need to add the maven-compiler-plugin and exec-maven-plugin plugins in your pom.xml. If they don't already exist, add them as follows.

<plugin>
  <groupId>org.apache.maven.plugins</groupId>
  <artifactId>maven-compiler-plugin</artifactId>
  <version>${maven-compiler-plugin.version}</version>
  <configuration>
    <source>${java.version}</source>
    <target>${java.version}</target>
  </configuration>
</plugin>
<plugin>
    <groupId>org.codehaus.mojo</groupId>
    <artifactId>exec-maven-plugin</artifactId>
    <version>3.1.0</version>
</plugin>

C# Quickstart App

Python Quickstart App

• Node.js Quickstart App
• Browser Quickstart App

Java Quickstart App