abstractMqttDriver-AzureMqttSasAuthenticator
This component sets up a secure connection between the Niagara a Abstract MQTT device and the Azure IoT Hub.
Figure 5. AzureMqttSasAuthenticator properties
Azure Mqtt Sas Authenticator is contained in the abstractMqttDriver palette.
To access these properties, expand , double-click AzureSasTokenMqttDevice and double-click authenticator.
| Property | Value | Description |
|---|---|---|
| Broker Endpoint | IP address, URL or hostname | Specifies the IP address, URL or Hostname of the broker. |
| Client ID | text 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 Port | number | Specifies the port number of the broker. |
| Callback Router | additional properties | Directs a client request to an appropriate function. A separate topic documents these router functions. |
| Ssl Version | enum | Reports the TLS (Transfer Layer Security) version currently being used. |
| Advance Expiration | hours, 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 Generation | true (default) or false |
When set to true, the authenticator automatically reconnects the parent MQTT device after a new token is generated.
|
| Last Error | read-only | The most recent error caused by token management functions. |
| Last Error Time | read-only | The 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.