Configuration

This section explains each of the properties in the configuration blade. 
General
Property
Description
Collection
This associates the Agent to a specific Collection (defaults to that of the current Data Stream).
Polling Interval (seconds)
A timespan to specify how often should the Agent check for new data/changes or update its cache.
Refer to Collections and Stream Hosts to understand more about Collections.
Authentication
Property
Description
Use Variables?
Tick to use Server Variables for the Tenant Id, Client Id, and Client Secret properties; or enter them manually.
Tenant Id
The Id of the tenant to which the Client belongs.
Client Id
The Id of the Azure App Registration the Agent uses to connect to the Azure Digital Twin instance.
Client Secret
The Secret of the Azure App Registration the Agent uses to connect to the Azure Digital Twin instance.
Digital Twin
Tick Specify Query to see additional options.
Property
Description
Endpoint URI
The URI of the Digital Twins instance, in the format "https://***.api.aue.digitaltwins.azure.net/"
Specify Query
Tick to enable custom query input.
Model Name
The name of the model for which to retrieve data (applies when Specify Query is unticked).
Query
Enter a custom Digital Twin query (applies when Specify Query is ticked).
Fetch Query Properties
Click to populate Query Properties based on the Query entered (applies when Specify Query is ticked).
The Type may need adjusting if the sample data is inconclusive.
Query Properties (Name, Type)
The Name and Type of each column in the source query, as they will appear in the output payload (applies when Specify Query is ticked). 
​
The attribute data types used for the output payload are String, Long, Double, Boolean, DateTime, or Integer. 
Endpoints
Name
Description
Output
Every Digital Twin of the configured Model (or Query) will be output on this endpoint with attributes matching the model's properties (or the Query Properties).
Error
If errors are encountered during the execution of this Agent they will be published on this endpoint.

Property	Description
Collection	This associates the Agent to a specific Collection (defaults to that of the current Data Stream).
Polling Interval (seconds)	A timespan to specify how often should the Agent check for new data/changes or update its cache.

Property	Description
Use Variables?	Tick to use Server Variables for the Tenant Id, Client Id, and Client Secret properties; or enter them manually.
Tenant Id	The Id of the tenant to which the Client belongs.
Client Id	The Id of the Azure App Registration the Agent uses to connect to the Azure Digital Twin instance.
Client Secret	The Secret of the Azure App Registration the Agent uses to connect to the Azure Digital Twin instance.

Property	Description
Endpoint URI	The URI of the Digital Twins instance, in the format "https://***.api.aue.digitaltwins.azure.net/"
Specify Query	Tick to enable custom query input.
Model Name	The name of the model for which to retrieve data (applies when Specify Query is unticked).
Query	Enter a custom Digital Twin query (applies when Specify Query is ticked).
Fetch Query Properties	Click to populate Query Properties based on the Query entered (applies when Specify Query is ticked). The Type may need adjusting if the sample data is inconclusive.
Query Properties (Name, Type)	The Name and Type of each column in the source query, as they will appear in the output payload (applies when Specify Query is ticked). The attribute data types used for the output payload are String, Long, Double, Boolean, DateTime, or Integer.

Name	Description
Output	Every Digital Twin of the configured Model (or Query) will be output on this endpoint with attributes matching the model's properties (or the Query Properties).
Error	If errors are encountered during the execution of this Agent they will be published on this endpoint.

Last modified 7mo ago