Versions Compared

Key

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

...

  • Setting Name
    • This is a friendly name of the Azure IoT Hub used to easily identify it.  This must also be unique.
  • Password/Connection String
    • This is the Azure IoT Hub connection string used to connect.  This string can be one of the following:
      • An IoT Hub connection string with the following format:
        • HostName=<Host Name>;SharedAccessKeyName=<Key Name>;SharedAccessKey=<SAS Key>
      • An IoT Hub's Event Hub-compatible connection string with the following format:
        • Endpoint=<ENDPOINT>;SharedAccessKeyName=<Key Name>;SharedAccessKey=<KEYVALUE>
      • An IoT Hub device connection string with the following format:
        • HostName=<Host Name>;DeviceId=<Device Name>;SharedAccessKey=<Device Key>
        • Note: If using MQTT as the protocol (next section), this is the connection string format that must be used.
  • Protocol
    • The protocol to use when connecting to the Azure IoT Hub.  It can be one of the following: 
      • MQTT
        • Note: If using MQTT as the protocol, the connection string (previous section) must be a 'device' connection string.
      • HTTPS
      • AMQPS
      • AMQPS_WS
  • Set
    • The Set to associate this Azure IoT Hub connection with.
    Certificate File Upload
    • The server certificates to use if required.

Store & Forward

  • Store & Forward Enabled
    • Whether to enable Store & Forward capbilities capabilities 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

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

Image RemovedImage Added

Azure Event Hubs

...

  • Setting Name
    • This is a friendly name of the Azure Event Hub used to easily identify it.  This must also be unique.
  • 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.

...