Add Azure IoT Hub source to an eventstream

This article shows you how to add an Azure IoT Hub source to a Microsoft Fabric eventstream.

Prerequisites

• Access to a workspace in the Fabric capacity license mode or trial license mode with Contributor or higher permissions.

• Appropriate permission to get your IoT hub's access keys. If your IoT hub is within a protected network, connect to it by using a managed private endpoint. Otherwise, ensure that the IoT hub is publicly accessible and not behind a firewall.

• Appropriate permission to get your IoT hub's access keys. If your IoT hub is within a protected network, connect to it by using a streaming vNet data gateway. Otherwise, ensure that the IoT hub is publicly accessible and not behind a firewall.

• An eventstream. If you don't have an eventstream, create one.

Start the wizard for selecting a data source

If you haven't added any source to your eventstream yet, select the Connect data sources tile. You can also select Add source > Connect data sources on the ribbon.

If you're adding the source to an already published eventstream, switch to Edit mode. On the ribbon, select Add source > Connect data sources.

On the Select a data source page, search for Azure IoT Hub. On the Azure IoT Hub tile, select Connect.

Configure an Azure IoT Hub connector

1. On the Connect page, select New connection.

   

   If there's an existing connection to your IoT hub, select that existing connection, and then move on to configuring Data format in the following steps.

   

2. In the Connection settings section, for IoT Hub, specify the name of your IoT hub.

   

3. In the Connection credentials section, follow these steps:

   1. If there's an existing connection, select it from the dropdown list. If not, confirm that Create new connection is selected for this option.

   2. For Connection name, enter a name for the connection to the IoT hub.

   3. For Authentication kind, confirm that Shared Access Key is selected.

   4. For Shared Access Key Name, enter the name of the shared access key.

   5. For Shared Access Key, enter the value of the shared access key.

      To get the name and value of the shared access key, follow these steps:

      1. Go to the page for your IoT hub in the Azure portal.
      2. On the left pane, under Security settings, select Shared access policies.
      3. Select a policy name from the list. Note down the policy name.
      4. Select the copy button next to the Primary key.

      

4. Select Connect.

   

5. For Consumer group, enter the name of the consumer group. The default consumer group for the IoT hub is $Default.

6. For Data format, select a data format for the incoming real-time events that you want to get from your IoT hub. You can select from JSON, Avro, and CSV data formats. Then select Connect.

Stream or source details

1. On the Connect page, follow one of these steps based on whether you're using Eventstream or Real-Time hub.

   • Eventstream:

     In the Source details pane to the right, follow these steps:

     1. For Source name, select the Pencil button to change the name.

     2. Notice that Eventstream name and Stream name are read-only.

   • Real-Time hub:

     In the Stream details section to the right, follow these steps:

     1. Select the Fabric workspace where you want to create the eventstream.

     2. For Eventstream name, select the Pencil button, and enter a name for the eventstream.

     3. The Stream name value is automatically generated for you by appending -stream to the name of the eventstream. This stream appears on the real-time hub's All data streams page when the wizard finishes.

2. Select Next at the bottom of the Configure page.

Review and connect

On the Review + connect screen, review the summary, and select Add (Eventstream) or Connect (Real-Time hub).

1. On the Connect page, for Feature level, select Extended features (Preview).

   

   If there's an existing connection to your Azure IoT Hub, select that existing connection, and then move on to the step to configure Azure IoT Hub data source.

2. In the Connection settings section, enter the name of your Azure IoT Hub:

   

3. In the Connection credentials section, do these steps:

   1. If there's an existing connection, select it from the dropdown list. If not, confirm that Create new connection is selected for this option.

   2. For Connection name, enter a name for the connection to the IoT Hub.

   3. For Data gateway, select the appropriate option based on your IoT Hub network configuration:

      • If your IoT Hub is public, select none.
      • If your IoT Hub is under a private network and you want to connect through a streaming virtual network data gateway, select the streaming vNet data gateway (prefixed with [Streaming VNet]). You can select the refresh icon to get the newly created gateway listed.

      Note

      If a data gateway is selected, skip the test connection step in this connection creation wizard.

   4. For Authentication kind, the default value is Shared Access Key.

   5. For Shared Access Key Name, enter the name of the shared access key.

   6. For Shared Access Key, enter the value of the shared access key.

   7. Select Connect at the bottom of the page.

      

      To get the access key name and value, follow these steps:

      1. Navigate to the IoT Hub page for your Azure IoT Hub in the Azure portal.

      2. On the IoT Hub page, select Shared access policies under Security settings on the left navigation menu.

      3. Select a policy name from the list. Note down the policy name.

      4. Select the copy button next to the Primary key.

         

4. Now, on the Connect page of wizard, for Consumer group, enter the name of the consumer group. By default, $Default is selected, which is the default consumer group for the IoT Hub.

5. For Starting position, select where in the stream to start reading records.

6. Then, select Next at the bottom of the page.

   

7. On the Review + connect page, select Add now.

   

Stream or source details

1. On the Connect page, follow one of these steps based on whether you're using Eventstream or Real-Time hub.

   • Eventstream:

     In the Source details pane to the right, follow these steps:

     1. For Source name, select the Pencil button to change the name.

     2. Notice that Eventstream name and Stream name are read-only.

   • Real-Time hub:

     In the Stream details section to the right, follow these steps:

     1. Select the Fabric workspace where you want to create the eventstream.

     2. For Eventstream name, select the Pencil button, and enter a name for the eventstream.

     3. The Stream name value is automatically generated for you by appending -stream to the name of the eventstream. This stream appears on the real-time hub's All data streams page when the wizard finishes.

2. Select Next at the bottom of the Configure page.

Note

An eventstream can support up to 11 combined sources and destinations only when you're using the following types:

• Source: Custom endpoint.
• Destinations: Custom endpoint and eventhouse with direct ingestion.

Any sources or destinations not included in the preceding list, and destinations not appended to the default stream, don't count toward this limit.

View an updated eventstream

1. Confirm that the Azure IoT Hub source is added to your eventstream on the canvas in the Edit mode. To implement this newly added IoT hub, select Publish on the ribbon.

   

2. The IoT hub is available for visualization in the Live view. Select the IoT hub tile in the diagram to display a page similar to the following example.

   

Related content

• For a list of supported sources, see Add and manage an event source in an eventstream.