Configure the product to receive Azure Event Hub messages

To configure Insight to receive messages from an Event Hub, you must get information from Azure, then use that information to set up the Event Hub data source in Insight.

Get the connection string and consumer group information from Azure

When you define your Event Hub data source in Insight, you need to provide the Event Hub Shared Access Listen Policy connection string and consumer group from Azure.

Note: The steps provided here are to assist you in getting the information you need to set up your data source in Insight. For detailed information about Azure, refer to the Microsoft documentation at Microsoft Documentation.

To get the connection string and consumer group from Azure

1. In your Azure portal, select the Event Hub you set up for Insight.

2. Select Shared access policies.

   

3. Select Add to add a policy to enable Insight to receive messages from the Event Hub.

4. Type the Policy name, select Listen, then select Create.

   

   The new policy displays in the list, and the connection string is generated.

5. Copy the Connection string - primary key.

   

   This connection string goes in the Listener Policy Connection String field when you define your Event Hub data source in Insight.

   Important: For security reasons, we recommend that you only provide a key that has the Listen claim. Insight does not need to send data or manage the Event Hub.

6. Select Consumer groups.

   

   You can use the $Default consumer group, or create a new one dedicated to Insight.

   We recommend you use a dedicated consumer group for production data sources.

7. Note the name of the consumer group.

   This name goes in the Consumer group field when you define your Event Hub data source in Insight.

Define an Event Hub data source

After you get the connection string and consumer group information from Azure, you need to define an Event Hub data source in Insight.

To define an Event Hub data source

8. Select Administration from the navigation rail.

9. Select Data Sources.

   

10. Select and then select Azure IoT/Event Hub.

    The Add Azure IoT/Event Hub Data Source dialog displays.

11. Type a name for the data source you are creating in Insight in the Name field.

12. Type the name of the event hub you created in your Azure portal for use with Insight in the Azure IoT/Event Hub Name field.

13. Specify the Connection String.

    This is the connection string you generated in Azure. See Get connection string and consumer group information from Azure.

14. Type the Consumer group.

    This is the consumer group in Azure that you are using with Insight. See Get connection string and consumer group information from Azure.

    

15. Under Options, you can toggle the Events checkbox to configure the data source for events support. See Processing Event data from an Event Hub/IoT Hub data source for more information. Note that Process Data is enabled by default and cannot be unchecked.

16. Optionally, do one of the following to specify the location for all unassigned tags in this data source:

    • Choose a location from the drop-down list.

    • Type a new location.

17. Below Geolocation Coordinates, specify the following to be applied to all unassigned tags in this data source:

    • Latitude in decimal degrees with plus/minus format (where "+" is optional).

    • Longitude in decimal degrees with plus/minus format (where "+" is optional).

    • Elevation (optional) noted in meters above sea level, specified to the first decimal place (for example:10.0 or 1322.5).

    Note: For latitude and longitude, do not use degree, minute, second (DMS) or decimal degrees with N/E/S/W. Geolocation values may include decimal separators, consistent with English culture.

18. Select Test Connection.

    If the connection is not successful, you receive an error message informing you what the issue is. Some issues you may encounter include:

    • incorrect connector settings

    • connection string is not using a listen claim

    • another component is already connected to the same Azure IoT/Event Hub

    You can correct the issue, then select Test Connection again.

    If there are no issues, you receive a message that the connection was successful, and the OK button displays.

19. Select OK to continue.

    The Upload dialog displays.

    This dialog is not required when setting up an Event Hub data source.

20. Select Close.