Share via

DataflowEndpointMqtt interface

  • Reference
Package:
@azure/arm-iotoperations

Broker endpoint properties

Properties

authentication

authentication properties. DEFAULT: kubernetes.audience=aio-internal. NOTE - Enum field only property is allowed
clientIdPrefix

Client ID prefix. Client ID generated by the dataflow is -TBD. Optional; no prefix if omitted.
cloudEventAttributes

Cloud event mapping config.
host

Host of the Broker in the form of :. Optional; connects to Broker if omitted.
keepAliveSeconds

Broker KeepAlive for connection in seconds.
maxInflightMessages

The max number of messages to keep in flight. For subscribe, this is the receive maximum. For publish, this is the maximum number of messages to send before waiting for an ack.
protocol

Enable or disable websockets.
qos

Qos for Broker connection.
retain

Whether or not to keep the retain setting.
sessionExpirySeconds

Session expiry in seconds.
tls

TLS configuration.

Property Details

authentication

authentication properties. DEFAULT: kubernetes.audience=aio-internal. NOTE - Enum field only property is allowed

authentication: DataflowEndpointMqttAuthentication

Property Value

DataflowEndpointMqttAuthentication

clientIdPrefix

Client ID prefix. Client ID generated by the dataflow is -TBD. Optional; no prefix if omitted.

clientIdPrefix?: string

Property Value

string

cloudEventAttributes

Cloud event mapping config.

cloudEventAttributes?: string

Property Value

string

host

Host of the Broker in the form of :. Optional; connects to Broker if omitted.

host?: string

Property Value

string

keepAliveSeconds

Broker KeepAlive for connection in seconds.

keepAliveSeconds?: number

Property Value

number

maxInflightMessages

The max number of messages to keep in flight. For subscribe, this is the receive maximum. For publish, this is the maximum number of messages to send before waiting for an ack.

maxInflightMessages?: number

Property Value

number

protocol

Enable or disable websockets.

protocol?: string

Property Value

string

qos

Qos for Broker connection.

qos?: number

Property Value

number

retain

Whether or not to keep the retain setting.

retain?: string

Property Value

string

sessionExpirySeconds

Session expiry in seconds.

sessionExpirySeconds?: number

Property Value

number

tls

TLS configuration.

tls?: TlsProperties

Property Value

TlsProperties