Overview
The AzureIotHub Import connects to the built-in endpoint of the Azure IOT Hub. By default the IOT Hub exposes the endpoint as an Azure Service Bus compatible endpoint. This allows clients to connect using the AMQPS protocol, which is used by the AzureIotHub import. The default port for AMQPS is port 5671 and a forecasting shell server should be allowed to connect to the Azure IOT Hub using this port from the Forecasting Shell Server.
The AzureIotHub import is a long running import that will keep running for one hour and will keep listening voor messages to arrive. After one hour the import will finish and state is store to keep track of the messages that have been imported. Since the import is completed after one hour, imports should be scheduled hourly and the import should never run in parallel on multiple Forecasting Shell Servers.
Import Configuration
General Section
The importType should be set to: AzureIotHub
The serverUrl should be set to a valid URL, but is used for informational purposes only and will be displayed in the import status. It can be set to the event hub domain url, for example: https://delft-fews-iot-hub.azure-devices.net
The dataFeedId is required and can be set to any unique dataFeedId. For example: Delft-FEWS Azure IOT Hub
Properties
To configure the AzureIotHub import, some required properties have to be specified.
| Property name | Description | Example value | Azure Portal Screenshot |
|---|---|---|---|
eventHubCompatiblePath consumersGroup | iothub-ehub-delft-fews-3109254-e665c23b62 $Default | ||
eventHubCompatibleHostname | ihsuprodamres086dednamespace.servicebus.windows.net | ||
sharedAccessPolicyName | V86dqC3AhjIqSgvAuShKDSsNamUJh5rJrqZ1e3hw7EA= | ||
numberOfPartitions | 2 | ||
runningTimeMilliseconds | Specifies how long the import will run in milliseconds. Default is one hour. Should only be changed for testing. | 120000 |
Examples
This example is configured to import scalar observations from the Azure IOT Hub
<?xml version="1.0" encoding="UTF-8"?>
<timeSeriesImportRun xmlns="http://www.wldelft.nl/fews" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.wldelft.nl/fews
http://fews.wldelft.nl/schemas/version1.0/timeSeriesImportRun.xsd">
<import>
<general>
<importType>AzureIotHub</importType>
<serverUrl>https://delft-fews-iot-hub.azure-devices.net</serverUrl> <!-- Not actually used -->
<relativeViewPeriod unit="day" start="-7" end="1" ></relativeViewPeriod>
<missingValue>-99.99</missingValue>
<dataFeedId>Azure IOT Hub</dataFeedId> <!-- data feed id is required for IOT hub -->
</general>
<properties>
<string key="eventHubCompatiblePath" value="iothub-ehub-delft-fews-3109254-e665c23b62" />
<string key="consumersGroup" value="$Default" />
<string key="eventHubCompatibleHostname" value="ihsuprodamres086dednamespace.servicebus.windows.net" />
<string key="sharedAccessPolicyName" value="service" />
<string key="sharedAccessPolicyKey" value="V86dqC3AhjIqSgvAuShKDSsNamUJh5rJrqZ1e3hw7EA=" />
<int key="numberOfPartitions" value="2" />
<int key="runningTimeMilliseconds" value="120000" /> <!-- run for 2 minutes for testing. Overrules the default running time of one hour -->
</properties>
<timeSeriesSet>
<moduleInstanceId>ImportObserved</moduleInstanceId>
<valueType>scalar</valueType>
<parameterId>T.obs</parameterId>
<locationSetId>LocationSetId</locationSetId>
<timeSeriesType>external historical</timeSeriesType>
<timeStep unit="nonequidistant"/>
<readWriteMode>add originals</readWriteMode>
<expiryTime unit="year" multiplier="1"/>
</timeSeriesSet>
</import>
</timeSeriesImportRun>
