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).

Refer to Collections and Stream Hosts to understand more about Collections.

Authentication

Property	Description
Use Variables?	Tick to select saved Variables for the Authentication, Host URL, and Relay properties; or enter the text manually.
Subscription Id	The Id of the Azure subscription to which the Client has access. This is required if you wish to create or manage an Azure Digital Twins instance through this Agent's configuration blade and requires the Client to have additional administration permissions.
Tenant Id	The Id of the tenant to which the Client belongs.
Client Id	The Id of the Azure App Registration the Agent should use to connect to the Azure Digital Twin instance.
Client Secret	The Secret of the Azure App Registration the Agent should use to connect to the Azure Digital Twin instance.

Once the Authentication details are entered, the Agent will attempt to authenticate and populate the dropdowns with available information from the Digital Twin instance: Model, Resource Group, and the Event Topic Name with the available Topics from your Azure Subscription.

Digital Twin Service

Azure Digital Twins uses Event Routes to send data and is defined by its Endpoint and Filter. The type of Endpoint that it uses is an Event Grid with custom Topics and it Filters events to only notify Changes or Telemetry Messages on the selected Digital Twin Model.

Property	Description
Host Url	The Host Name of the Azure Digital Twins instance. This can either be the simple name or the full URL in the format "https://<instancename>.api.<region>.digitaltwins.azure.net"
Use Query	Tick to enter a custom query string, or leave unticked to use the Model and Relay infrastructure.
Model	The name of the Digital Twin model to listen to (applies when Use Query is unticked).
Query Polling Interval	A timespan to specify how often should the Agent check for updated data (applies when Use Query is ticked).
Query	The query to run on the Digital Twin server (applies when Use Query is ticked).
Fetch Query Properties	Press this button to update the Properties table with data from the Query (applies when Use Query is ticked).
Properties (Name, Type)	The Name and Type of each column in the source query, as they will appear in the output payload (applies when Use Query is ticked). The attribute data types used for the output payload are String, Long, Double, Boolean, DateTime, or Integer.
Primary Key	The combination of Properties that uniquely identifies a Digital Twin (applies when Use Query is ticked).

Create an Endpoint

This link opens a sub-page that allows you to create a new Endpoint and Event Route with the selected Topic for the Digital Twins Instance.

Property	Description
Resource Group	The resource group the new resource will be assigned to.
Resource Location	Choose one of Azure's supported regions in which to create the resource.
Digital Twin Endpoint Name	The name of the new Digital Twin instance endpoint.
Digital Twins Route Name	The name of the event route for the new Digital Twin instance endpoint.
Create Event Topic?	Tick to create a new Event Grid Topic using the input from Event Topic Name.
Event Topic Name	The name of the Event Grid Topic for the source of Events. Input manually to create a new Event Topic (applies only when Create Event Topic? is ticked).

Relay

If Use Query is not ticked, an Azure Relay must be set up and attached to the Azure Digital Twins instance to securely communicate with the Event Grid Endpoint and receive event notifications from it.

Property	Description
Namespace	The Namespace of the Azure Relay.
Connection	The name of the Azure Relay Connection to use.
Access policy name	The name of the policy for the Azure Relay authentication.
Access Key	The key for the Azure Relay authentication.

Create a Relay

This link opens a sub-page that allows you to create a new Azure Relay to connect to the Event Grid endpoint.

Property	Description
Resource Group	The resource group the new resource will be assigned to.
Resource Location	Choose one of Azure's supported regions in which to create the resource.
Relay Name	The name of the new Azure Relay Connection.

Once a new Relay is created, click Apply on this blade to insert the new Relay Name, Access policy name, and Access Key into the main configuration blade.

Create a Connection

This link opens a sub-page that allows you to create a new connection between the Azure Relay and the Event Grid endpoint. The Relay details must have values to create a new Connection.

Property	Description
Resource Group	The resource group that contains the Digital Twin Instance.
Resource Location	Choose one of Azure's supported regions in which to create the resource.
Connection Name	The name of the new Azure Relay Connection.
Create Event Topic?	Tick to create a new Event Grid Topic using the input from Event Topic Name.
Event Topic Name	The name of the Event Grid Topic for the source of Events. Input manually to create a new Event Topic (applies only when Create Event Topic? is ticked).
Event Subscription Name	The name of the Event Subscription to an Event Grid Topic

Once a new Connection is created, the new Connection Name can be used as input for the Connection property on the main configuration blade.

Endpoints

Name	Description
Output	An event per Digital Twin Update or Telemetry Message of the selected Model will be made available on this endpoint with attributes matching the Properties and Telemetry contents of the selected Model.
Error	Errors encountered during the execution of this Agent will be published on this endpoint.