Configuration

This section explains each of the properties in the configuration blade.
General
Property
Description
Name
The name that will appear in the Data Source list.
Server
Property
Description
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 all the Cluster 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.
Property
Description
Database
The name of the database to connect to.
Once selected, the Table property is populated with the list of available tables in the database.
Table
The name of the table 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)

Query Parameter format: queryparam("StartTime","DateTime","2022-01-01") 

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 parameter value is not supplied from app page. All 3 attributes should be enclosed in double quotes and the attribute value shouldn't contain a double quote. 

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")
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 which 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 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
Property
Description
Is Timeseries Data?
Tick to specify if specified Table or ADX Query contains timeseries data.
Timestamp Column
The column that contains timestamp value and uniquely identifies each row.
Use Timeseries Aggregation?
Tick to specify whether aggregation is applied to the timeseries data.
Aggregation Parameters
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.
Property
Description
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
This applies when Is Timeseries Data is ticked.
Property
Description
Enable Polling?
Tick to specify if connector should enable live updates. 
Polling Interval (seconds)
Specify how often connector should look for new records.

Property	Description
Name	The name that will appear in the Data Source list.

Property	Description
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.

Property	Description
Database	The name of the database to connect to. Once selected, the Table property is populated with the list of available tables in the database.
Table	The name of the table 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) Query Parameter format: `queryparam("StartTime","DateTime","2022-01-01")` 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 parameter value is not supplied from app page. All 3 attributes should be enclosed in double quotes and the attribute value shouldn't contain a double quote. 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")`
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 which 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 timezone and the apps will not convert the values to the local timezone.

Property	Description
Is Timeseries Data?	Tick to specify if specified Table or ADX Query contains timeseries data.
Timestamp Column	The column that contains timestamp value and uniquely identifies each row.
Use Timeseries Aggregation?	Tick to specify whether aggregation is applied to the timeseries data.

Property	Description
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.

Property	Description
Enable Polling?	Tick to specify if connector should enable live updates.
Polling Interval (seconds)	Specify how often connector should look for new records.

Last modified 1mo ago