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.
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.09
Request the Azure Digital Twin Context Provider v1.05
Request the Azure Digital Twin Action Agent v1.21
Please contact XMPro if you're looking for an older version of this Agent.
Listener Release Notes
v1.09, 16 Apr 2024
Fixed an error when opening the configuration blade by repackaging to include the Azure Client DLL (Microsoft.IdentityModel.Clients.ActiveDirectory)
v1.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
Older
v1.07, 31 Oct 2023
Added support for a query string
v1.06, 8 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.
v1.05, 21 Oct 2021
Fixed blank configuration blade when incorrect authentication values are used
v1.04, 29 Apr 2021
Split up the infrastructure setup into relay, connection, and DT Endpoint steps
v1.03, 28 Apr 2021
Added Relay infrastructure setup
v1.02, 28 Apr 2021
Nulls are inserted when properties or telemetry points are missing
v1.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
v1.0, 15 Apr 2021
Initial Release
Context Provider Release Notes
v1.05, 07 Jun 2024
Fixed an error when opening the configuration blade by repackaging to include the Azure Client DLL (Microsoft.IdentityModel.Clients.ActiveDirectory)
v1.04, 23 Feb 2023
Fixed parsing error during conversion of JSON Type and Schema
Older
v1.03, 20 Sep 2022
Added support for custom Digital Twins query
v1.02, 10 Nov 2020
Missing properties are filled by nulls
v1.01, 10 Nov 2020
Added "$dtId" and "$etag" to list of outputs
v1.0, 9 Nov 2020
Initial Release
Action Agent Release Notes
v1.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
v1.20, 07 Jun 2024
Fixed an error when opening the configuration blade by repackaging to include the Azure Client DLL (Microsoft.IdentityModel.Clients.ActiveDirectory)
Older
v1.19, 17 May 2023
Replace Time Series Insights with Azure Data Explorer
v1.18, 01 Dec 2022
Repackaged to include the Agent's Category
v1.17, 19 Aug 2022
Azure resource creation is now controlled by an environment variable and is disabled by default
v1.16, 8 Nov 2021
Fixed outputs being blank
v1.15, 21 Oct 2021
Fixed blank configuration blade when incorrect authentication values are used
v1.14, 14 Apr 2021
Reintroduced model parser pre-check
MUST run on Stream Host with Newtonsoft.Json 12.0.3 or higher
v1.13, 14 Apr 2021
Fixed bug in 1.12 when using non-variable connection to DT
v1.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
v1.11, 13 Apr 2021
Moved TSI resource creation to its own sub page
v1.10, 13 Apr 2021
Added variable options for TSI
Added Event hub to infrastructure creation
v1.09, 4 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.
v1.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
v1.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
v1.05, 20 Nov 2020
Agent now takes enables relationship inputs from a grid and takes relationship properties from input mapping.
v1.04, 11 Nov 2020
Agent can now set relationships.
v1.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.
v1.02, 19 Oct 2020
Added option to use variables to define connection.
v1.01, 15 Oct 2020
Existing twins of the selected model are listed as options
v1.0, 12 Oct 2020
Initial Release
Last updated