abstractMqttDriver-AzureMqttSasAuthenticator

This component sets up a secure connection between the Niagara a Abstract MQTT device and the Azure IoT Hub.

Figure 1. AzureMqttSasAuthenticator properties


Azure Mqtt Sas Authenticator is contained in the abstractMqttDriver palette.

To access these properties, expand Config > Drivers > AbstractMqttDriverNetwork, double-click AzureSasTokenMqttDevice and double-click authenticator.

PropertyValueDescription
Broker EndpointIP address, URL or hostname
Specifies the IP address, URL or Hostname of the broker.
Client IDtext string
Identifies the client to the server. If not specified, the system generates a unique Client ID.

No other client should currently use or in the future use this unique string. If two devices share the same Client ID, Status reports {down} or {fault}, unexpected behaviors happen and communication issues between client and broker result.

Broker Portnumber
Specifies the port number of the broker.
Callback Routeradditional properties
Directs a client request to an appropriate function. A separate topic documents these router functions.
Ssl VersionenumReports the TLS (Transfer Layer Security) version currently being used.
Advance Expirationhours, minutes, seconds (defaults to 10 seconds)Defines the time period prior to the token’s expiry that a new token will be generated replacing the existing token.
Reconnect After Token Generationtrue (default) or falseWhen set to true, the authenticator automatically reconnects the parent MQTT device after a new token is generated.
Last Errorread-onlyThe most recent error caused by token management functions.
Last Error Timeread-onlyThe time of the most recent error.

Actions

To perform an action, right-click authenticator, select Actions and select the action.

  • Generate New Token: Manually generates a new SAS token to use for connections. It replaces any existing token.

  • Setup From Connection String: Configures the authenticator and generates a new SAS token from that configuration.