Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

One or more Azure Event Hub endpoints can be configured on this tab.

Notes

  • Ports 5671 and 5672 need to be opened for outbound traffic so the EventHubClient can establish an AMQP connection to the EventHub.

The configuration options for an Azure Event Hub connection are listed below.

...

  • Setting Name
    • This is a friendly name of the Azure Event Hub used to easily identify it.  This must also be unique.
  • Enabled
    • Whether or not this connection is enabled.
  • Password/Connection String
    • This is the Azure Event Hub connection string used to connect. 
    • NOTES: Be sure to provide the connection string for the EventHub itself and not the EventHub Namespace. They both have connection strings, but the one for the EventHub will be of the form -

      Endpoint=<YOUR_ENDPOINT>;SharedAccessKeyName=<YOUR_KEYNAME>;SharedAccessKey=<YOUR_KEY>=;EntityPath=<YOUR_EVENTHUB_ENTITYPATH>

      The Namespace connection string will not contain the entity path.

  • Set
    • The Set to associate this Azure Event Hub connection with.
    Certificate File Upload
    • The server certificates to use if required.

Store & Forward

  • Store & Forward Enabled
    • Whether to enable Store & Forward capbilities for this endpoint
  • Store & Forward Type
    • The type of the Store & Forward mechanism
  • Message Capacity
    • The Maximum number of messages to store before dropping the oldest historical messages
  • Flush Period
    • The period of time to wait (in milliseconds) between sending when flushing messages

...

  • Max Message Size
    • The maximum message size for the Azure Event Hub. Default is 262144 bytes (256KB).
      • EventHub Basic: 262144 bytes (256KB)
      • EventHub Standard or better: 1048576 bytes (1MB)
  • Azure Date/Time Format
    • The date/time format to use when pushing messages to IoT Hub
      • LONG_MS_SINCE_EPOCH (default) - The timestamp values will all be as numbers in milliseconds since epoch (Jan 1, 1970) in UTC
      • STRING_AZURE_COMPAT - The timestamp will be pushed as described here. This is useful when wanting to use 'edge' timestamps in Azure Time Series insights.
    • See this tutorial for more details

Clicking on the "Create new Azure Event Hub Setting..." link will bring up the following form for adding a new Azure Event Hub endpoint.

...

The Sets tab contains a list of Azure Sets.  Each set represents a grouping of Azure IoT/Event Hub endpoints.  When a set is referenced by a Tag Agent the Agent will push Tag data to all Azure IoT/Event Hub endpoints contained within that Set. The Sets are disjoint, meaning that a single Azure IoT/Event Hub endpoint cannot be in more than one set.  Out of the box the Azure Injector module will have one "Default" set defined.

Image RemovedImage Added

Additional Sets can be configured for situations where multiple Tag Agents will need to push to different Azure IoT Hub endpoints. The configuration options for Sets are listed below.

...