Dynamics 365 SCM Sensor Data Intelligence, Azure sample template

This template deploys a set of baseline Azure resources for use in Dynamics 365 SCM Sensor Data Intelligence. Sensor Data Intelligence consumes output from an insights layer (Stream Analytics) to notify and affect business processes in Dynamics 365.

The template can reuse an existing IoT Hub from a previous Connected Field Service Azure resources deployment.

Sample pricing calculator; each unused Stream Analytics job can be stopped to incur zero costs.

This sample template is made available as is as a part of the Sensor Data Intelligence private preview. Microsoft makes no warranties, whether express or implied, of fitness for a particular purpose, of accuracy or completeness of responses, of results or conditions of merchantability. The entire risk of the use or the results from the use of this sample template remains with the user. No technical support is provided.

Overview and deployed resources

The following resources are deployed as part of the solution:

• Azure IoT Hub: sink for IoT signals
• Azure Stream Analytics job: for transforming IoT signals into insight signals
• Azure Cache for Redis: for real-time sensor metric visualizations in Dynamics
• Azure Function: for updating the Redis cache with sensor metrics
  • With an App Service plan
• Azure Storage Account: for storing reference data from Dynamics and AzureWebJobsStorage target for the Azure Function
• Azure Service Bus: for storing insight signals received from Stream Analytics to be sent to Dynamics
• Azure Logic Apps: for updating reference data in blobs from-, and forwarding insight signals from Service Bus to, Dynamics
• User assigned managed identity: for securely communicating with Dynamics from Logic apps

Prerequisites

It is expected that the entity deploying this already has some IoT systems emitting telemetry to be captured. If not, IoT simulators can be used to generate data for testing and validation.

Deployment steps

You can click the "Deploy to Azure" button at the beginning of this document.

Usage

It is expected that this solution will be used from within Dynamics 365, for Sensor Data Intelligence.

Connect

After deployment, you must allowlist the deployed user assigned managed identity's client ID in Dynamics.

Customize

After deployment, you will want to make changes to the Azure Stream Analytics job query (transform) to fit your IoT sensor telemetry into an expected shape.

To compile the Bicep file to ARM, you need to install AZ CLI. Invoke scripts/Build-ARMTemplate.ps1 to compile the template.

To update the Logic App definitions, consider making changes in the Azure Portal Logic App designer and copy-paste from "Code view" into the json file for the Logic App. On building the ARM template via scripts/Build-ARMTemplate.ps1 sensitive parameters are automatically cleared- consider running it before every commit to avoid committing sensitive data.

Consider turning off "Format on save" in VS Code, as the Azure Stream Analytics tool has some problems properly formatting larger queries at the time of writing.

Monitoring, scaling and VNet isolation

For details on adding monitoring, VNet isolation and information on scaling see: EXTENDED_USE.md.

Notes

It is not recommended to reuse the Stream Analytics job between Connected Field Service and Dynamics SCM Sensor Data Intelligence, as they will evolve independently and can clash if breaking changes are applied in one or the other.

This template is a baseline and is purposefully made simple. This means that; before going into production, you should go over the individually deployed resources and make sure that they are configured securely to the specifications of your organization.

To get around some issues with fetching keys for a function app while it is deploying, we are deploying a Deployment Script which just adds a wait of 30 seconds after deploying the Azure Function. We hope to remove this in the future.

We have a createUiDefinition.json file in this folder which lets us use a Resource Selector for the "Reuse existing IoT Hub" parameter.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.

Trademarks

This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft's Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.