Configuration

his section explains each of the properties in the configuration blade.

General

PropertyDescription

Name

The name that will be visible when selecting a data source.

Server

PropertyDescription

Use Connection Variables

Tick to use variables for the Cluster Url, Tenant ID, Client ID, and Secret Key settings; or enter them manually.

Cluster Url

The Host Name used to create, start, edit, list, terminate, and delete clusters - in the format https://{clusterName}.{location}.kusto.windows.net). You can find the URL on the Azure Portal blade for the Data Explorer Cluster under the "URI" property.

Tenant ID

The ID of the tenant to which the Client belongs.

Client ID

The ID of the Azure App Registration used to connect to the Azure Data Explorer instance.

Secret Key

The Secret of the Azure App Registration used to connect to the Azure Data Explorer instance.

Database

Once the Server Properties are entered, the Connector attempts to open a connection with the database server. If successful, the Database dropdown is populated with a list of available databases.

PropertyDescription

Database

The name of the database to connect to. Once selected, the Table property is populated with the list of available tables and materialized views in the database.

Table

The name of the table or materialized view to connect to (applies when Specify ADX Query is not ticked).

Once selected, the Primary Key Column and Columns To Return properties are populated with a list of the table's columns.

Specify ADX Query

Tick to query using a KQL statement, or select a table (default).

Use Query Parameters

Tick to use query parameters in the ADX Query (applies when Specify ADX Query is ticked) Below is an example of the query parameter format: queryparam("StartTime","DateTime","2022-01-01") Where StartTime is the name, DateTime is the data type (possible values are DateTime, Int, Long, Double, Boolean, String, Dynamic) and last attribute is the value of the parameter that is used to execute the query during configuration and also at runtime if the parameter value is not supplied from the app page. All 3 attributes should be enclosed in double quotes and the attribute value shouldn't contain a double quote. Below is an example ADX Query using query parameters: StormEvents | where StartTime > queryparam("StartDate","DateTime","2007-01-01") | where State in (queryparam("StateList","Dynamic","'ALABAMA','INDIANA'")) | take queryparam("NumRecords","Int","1000")

Specify ADX Query

Query Azure Data Explorer (ADX) through a KQL statement (applies when Specify ADX Query is ticked). This is useful when querying data by joining multiple tables or applying aggregation to a variable column selection. Refer to Identifier Quoting when your query includes identifiers that are the same as keywords or contain special characters.

Primary Key Column

The column used to uniquely identify each row.

Columns To Return

The columns that the Connector should return. If no columns are specified, all are returned. It is mandatory when Use Timeseries Aggregation is ticked.

Ignore TimeZone Info from DateTime values

By default, DateTime values are assumed to be in UTC. Tick to ignore the timezone and the apps will not convert the values to the local timezone.

If aggregation is required AND optional column selection, the aggregation should be implemented within the ADX query.

Special Characters in Identifier Names

These special characters are supported: (_) Underscore, (-) Dash, (.) Period and ( ) Space. The following special characters in ADX Query are not supported and will result in errors:

  • (*) Asterisk (Request is invalid and cannot be executed.)

  • (\) Backslash and (\\) Double Backslash (Parse error. No Values will be displayed.)

  • (.) Period (No Values will be displayed.)

Refer to Azure Data Explorer's Identifier Naming Rules for more information when creating your entity.

Timeseries Settings

PropertyDescription

Is Timeseries Data

Tick if the Table or ADX Query contains timeseries data.

Timestamp Column

The column that contains a timestamp value and uniquely identifies each row.

Use Timeseries Aggregation

Tick if aggregation is applied to the timeseries data.

Aggregation Parameters Properties

This applies when Is Timeseries Data and Use Timeseries Aggregation are ticked. Ensure at least one of the return columns is of numeric data type. Aggregation is applied to numeric columns, grouped by the remaining return columns.

PropertyDescription

Maximum Record Count

Specify the maximum number of records to be returned after applying dynamic aggregation. If the total number of records from the Table or ADX Query is below this number, the aggregation will not be applied and all rows will be returned.

Aggregation Type

The aggregation options are Average, Minimum, Maximum, and Any.

Live Notifications Properties

This applies when Is Timeseries Data is ticked.

PropertyDescription

Enable Polling

Tick to specify if the Connector should enable live updates.

Polling Interval (seconds)

Specify how often the Connector should look for new records.

Last updated