Page History

...

• Setting Name
  • This is a friendly name of the Azure IoT Hub used to easily identify it.  This must also be unique.
• Enabled
  • Whether or not pushing to this IoT Hub is enabled or not.this connection is enabled.
• 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 must be a 'device' connection string when not using certificate based authentication.
• Set
  
  • The Set to associate this Azure IoT Hub connection with.

Authentication

• Enable Certificate Based Authentication
  • Whether or not to use certificate based authentication. If not using certificate based authentication, the 'Password/Connection String' field must be used. If certificate based authentication is used, the other Authentications fields must be used.
• Password/Connection String (required if not using certificate based authentication)
  
  • 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.
    • Others may be available in the future
• Set
  
  • The Set to associate this Azure IoT Hub connection with.
• MQTT Hostname (required if using certificate based authentication)
  • This is the DNS endpoint name of your IoT Hub
• Device ID (required if using certificate based authentication)
  • The Device ID as provisioned in the IoT Hub to connect as
• CA Certificate File
  • The CA certificate file of your IoT Hub. See this document for more information.
  • The drop down is populated from a list of files that have been uploaded to the IoT Hub/Certificates tab.
• Client Certificate File (required if using certificate based authentication)
  • The client certificate file as provisioned for this device.
  • The drop down is populated from a list of files that have been uploaded to the IoT Hub/Certificates tab.
• Client Private Key File (required if using certificate based authentication)
  • The client private key file that was used in generating the certificate for this device
  • The drop down is populated from a list of files that have been uploaded to the IoT Hub/Certificates tab.
• Password/Private key password
  • The password used for the private key if one was specified for the key

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

...

Store & Forward

• Keep Alive
  • The MQTT keep alive timeout in seconds
• Max Message Size
  • The maximum message size before outbound messages will be divided into chunks smaller than the max message sizein bytes that any message can be when pushing to IoT Hub.
• Session Expiration
  • The number of seconds before the session token expires and is renewedHow long in seconds to specify for session token timeouts when not using certificate based authentication

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

...

• 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 pushing to this Event Hub is enabled or not.
• 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 IoT Hub connection with.
• Certificates
  • 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

Advanced

• Max Message Size
  • The maximum message size before outbound messages will be divided into chunks smaller than the max message size

...