Azure Digital Twin

The Azure Digital Twin Agents allow you to connect your Data Stream to an Azure Digital Twins instance.

The Azure Digital Twin platform is a cloud-based IoT offering that helps you create digital representations of real-world devices or business entities, including their intrinsic attributes as well as how their relationships with each other. For more information about the Azure Digital Twin platform, please see their store page and documentation.

The Listener allows you to listen for changes on an Azure Digital Twins Model. The Agent uses an Azure Relay Hybrid Connection to receive Event Notifications from a Digital Twin and output it to your Data Stream.

The Context Provider allows you to fetch the twin data from the Azure Digital Twins instance and output it as contextual data for the Data Stream. The information for every digital twin that the Agent is configured to read will be output every time it polls.

The Action Agent allows you to keep your Digital Twin instances up to date by taking Data Stream events and sending them as update or create requests. In addition, the Action Agent can integrate with an Azure Data Explorer instance, which enables you to contextualize the up-to-date information from the Digital Twin instance with historical data.

Azure resource creation

This Agent includes the capability to create Azure resources directly from the configuration blade.

To enable this functionality create an Environment Variable on the system where the Stream Host is installed, with a name of Azure:EnableResourceManagement and a value of true.

Pre-requisites

The following is required to use this Agent:

• The credentials of an Azure App Registration with permission to read the Azure Digital Twin instance.

• The Action Agent requires additional permission when Azure resource creation is enabled: to manage Azure Digital Twin instances.

• The Listener v1.08 requires a minimum XMPro Stream Host (SH) version required is 4.3.14, i.e. download the SH installer from XMPro Data Stream Designer v4.3.14 or later.

Current Version

• Request the Azure Digital Twin Listener v1.10

• Request the Azure Digital Twin Context Provider v1.06

• Request the Azure Digital Twin Action Agent v1.22

Please contact XMPro if you're looking for an older version of this Agent.

Listener Release Notes

Version	Date	Description
1.10	27 Dec 2024	Repackaged to translate the Agent's properties.
1.09	16 Apr 2024	Fixed an error when opening the configuration blade by repackaging to include the Azure Client DLL (Microsoft.IdentityModel.Clients.ActiveDirectory).
1.08	06 Feb 2024	Enhanced the engine polling introduced in v1.07 to leverage the updated IPollingAgent interface released in v4.3.14. This is a breaking change - note the updated pre-requisites.
1.07	31 Oct 2023	Added support for a query string.
1.06	08 Dec 2022	Fixed using the relay name from the Create Relay blade when using the Create Connection blade without using variables. Fixed the wrong settings being used when testing for a valid Connection. Fixed needing a valid Connection to see the Create Connection blade.
1.05	21 Oct 2021	Fixed blank configuration blade when incorrect authentication values are used.
1.04	29 Apr 2021	Split up the infrastructure setup into relay, connection, and DT Endpoint steps.
1.03	28 Apr 2021	Added Relay infrastructure setup.
1.02	28 Apr 2021	Nulls are inserted when properties or telemetry points are missing.
1.01	16 Apr 2021	Digital Twins connection is mandatory. Twins are fetched upon start and all available data is sent instead of only the updates.
1.00	15 Apr 2021	Initial Release.

Context Provider Release Notes

Version	Date	Description
1.06	27 Dec 2024	Repackaged to translate the Agent's properties.
1.05	07 Jun 2024	Fixed an error when opening the configuration blade by repackaging to include the Azure Client DLL (Microsoft.IdentityModel.Clients.ActiveDirectory).
1.04	23 Feb 2023	Fixed parsing error during conversion of JSON Type and Schema.
1.03	30 Sep 2021	Added support for custom Digital Twins query.
1.02	10 Nov 2020	Missing properties are filled by nulls.
1.01	10 Nov 2020	Added "$dtId" and "$etag" to list of outputs.
1.00	09 Nov 2020	Initial Release.

Action Agent Release Notes

Version	Date	Description
1.22	27 Dec 2024	Repackaged to translate the Agent's properties.
1.21	11 Jul 2024	Fixed assembly loading errors when publishing the Data Stream, which were caused by unresolved dependencies on the following DLLs: XMIoT.Framework.dll System.Threading.Tasks.Extensions.dll Newtonsoft.Json.dll
1.20	07 Jun 2024	Fixed an error when opening the configuration blade by repackaging to include the Azure Client DLL (Microsoft.IdentityModel.Clients.ActiveDirectory).
1.19	17 May 2023	Replace Time Series Insights with Azure Data Explorer.
1.18	01 Dec 2022	Repackaged to include the Agent's Category.
1.17	19 Aug 2022	Azure resource creation is now controlled by an environment variable and is disabled by default.
1.16	08 Nov 2021	Fixed outputs being blank.
1.15	21 Oct 2021	Fixed blank configuration blade when incorrect authentication values are used.
1.14	14 Apr 2021	Reintroduced model parser pre-check. MUST run on Stream Host with Newtonsoft.Json 12.0.3 or higher.
1.13	14 Apr 2021	Fixed bug in 1.12 when using non-variable connection to DT.
1.12	14 Apr 2021	Event hub resource creation now lists hub details in temporary boxes for easier copying. Renamed Event Hub Endpoint to Namespace for clarity. Namespace now accepts fully formatted namespaces ("sb://...") and simple names.
1.11	13 Apr 2021	Moved TSI resource creation to its own sub page.
1.10	13 Apr 2021	Added variable options for TSI. Added Event hub to infrastructure creation.
1.09	04 Mar 2021	Added model telemetry to inputs and twin operations. Removed model parser pre-check which relied on Newtonsoft.Json 12. Added help text to Resource locations. Fixed model upload being hiden under certain otherwise valid circumstances.
1.07	23 Feb 2021	Updated configuration screen with newly styled groups and title settings. Removed "Enabled" column from relationship grid. Relationship updates are now enabled/disabled by filling or leaving empty the Value column.
1.06	11 Feb 2021	Added resource management for Digital Twins and Resource groups. Changed config to list existing digital twins instances, when not in variables mode. Allowed the upload of models as .json files, or .zip files containing many .json files.
1.05	20 Nov 2020	Agent now takes enables relationship inputs from a grid and takes relationship properties from input mapping.
1.04	11 Nov 2020	Agent can now set relationships.
1.03	27 Oct 2020	Agent can now send to Event Hub for ingest to Time Series Insights and create Insights instances and types based on the Digital Twin model.
1.02	19 Oct 2020	Added option to use variables to define connection.
1.01	15 Oct 2020	Existing twins of the selected model are listed as options.
1.00	12 Oct 2020	Initial Release.