Class DataflowEndpointMqtt

Broker endpoint properties.

Inheritance
System.Object
DataflowEndpointMqtt
Namespace: System.Dynamic.ExpandoObject
Assembly: Azure.ResourceManager.IotOperations.dll
Syntax
public class DataflowEndpointMqtt : System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.IotOperations.Models.DataflowEndpointMqtt>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.IotOperations.Models.DataflowEndpointMqtt>

Constructors

DataflowEndpointMqtt(DataflowEndpointMqttAuthentication)

Initializes a new instance of DataflowEndpointMqtt.

Declaration
public DataflowEndpointMqtt (Azure.ResourceManager.IotOperations.Models.DataflowEndpointMqttAuthentication authentication);
Parameters
DataflowEndpointMqttAuthentication authentication

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

authentication is null.

Properties

Authentication

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

Declaration
public Azure.ResourceManager.IotOperations.Models.DataflowEndpointMqttAuthentication Authentication { get; set; }
Property Value
DataflowEndpointMqttAuthentication

ClientIdPrefix

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

Declaration
public string ClientIdPrefix { get; set; }
Property Value
System.String

CloudEventAttributes

Cloud event mapping config.

Declaration
public Nullable<Azure.ResourceManager.IotOperations.Models.CloudEventAttributeType> CloudEventAttributes { get; set; }
Property Value
System.Nullable<CloudEventAttributeType>

Host

Host of the Broker in the form of <hostname>:<port>. Optional; connects to Broker if omitted.

Declaration
public string Host { get; set; }
Property Value
System.String

KeepAliveSeconds

Broker KeepAlive for connection in seconds.

Declaration
public Nullable<int> KeepAliveSeconds { get; set; }
Property Value
System.Nullable<System.Int32>

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.

Declaration
public Nullable<int> MaxInflightMessages { get; set; }
Property Value
System.Nullable<System.Int32>

Protocol

Enable or disable websockets.

Declaration
public Nullable<Azure.ResourceManager.IotOperations.Models.BrokerProtocolType> Protocol { get; set; }
Property Value
System.Nullable<BrokerProtocolType>

Qos

Qos for Broker connection.

Declaration
public Nullable<int> Qos { get; set; }
Property Value
System.Nullable<System.Int32>

Retain

Whether or not to keep the retain setting.

Declaration
public Nullable<Azure.ResourceManager.IotOperations.Models.MqttRetainType> Retain { get; set; }
Property Value
System.Nullable<MqttRetainType>

SessionExpirySeconds

Session expiry in seconds.

Declaration
public Nullable<int> SessionExpirySeconds { get; set; }
Property Value
System.Nullable<System.Int32>

Tls

TLS configuration.

Declaration
public Azure.ResourceManager.IotOperations.Models.IotOperationsTlsProperties Tls { get; set; }
Property Value
IotOperationsTlsProperties

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Declaration
protected virtual void JsonModelWriteCore (System.Text.Json.Utf8JsonWriter writer, System.ClientModel.Primitives.ModelReaderWriterOptions options);
Parameters
System.Text.Json.Utf8JsonWriter writer

The JSON writer.
System.ClientModel.Primitives.ModelReaderWriterOptions options

The client options for reading and writing models.

Explicit Interface Implementations

IJsonModel<DataflowEndpointMqtt>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

Declaration
Azure.ResourceManager.IotOperations.Models.DataflowEndpointMqtt IJsonModel<DataflowEndpointMqtt>.Create (ref System.Text.Json.Utf8JsonReader reader, System.ClientModel.Primitives.ModelReaderWriterOptions options);
Parameters
System.Text.Json.Utf8JsonReader reader

The System.Text.Json.Utf8JsonReader to read.
System.ClientModel.Primitives.ModelReaderWriterOptions options

The System.ClientModel.Primitives.ModelReaderWriterOptions to use.
Returns
DataflowEndpointMqtt

A T representation of the JSON value.
Exceptions
System.FormatException

If the model does not support the requested System.ClientModel.Primitives.ModelReaderWriterOptions.Format.

IJsonModel<DataflowEndpointMqtt>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided System.Text.Json.Utf8JsonWriter.

Declaration
void IJsonModel<DataflowEndpointMqtt>.Write (System.Text.Json.Utf8JsonWriter writer, System.ClientModel.Primitives.ModelReaderWriterOptions options);
Parameters
System.Text.Json.Utf8JsonWriter writer

The System.Text.Json.Utf8JsonWriter to write into.
System.ClientModel.Primitives.ModelReaderWriterOptions options

The System.ClientModel.Primitives.ModelReaderWriterOptions to use.
Exceptions
System.FormatException

If the model does not support the requested System.ClientModel.Primitives.ModelReaderWriterOptions.Format.

IPersistableModel<DataflowEndpointMqtt>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided System.BinaryData into a model.

Declaration
Azure.ResourceManager.IotOperations.Models.DataflowEndpointMqtt IPersistableModel<DataflowEndpointMqtt>.Create (BinaryData data, System.ClientModel.Primitives.ModelReaderWriterOptions options);
Parameters
System.BinaryData data

The System.BinaryData to parse.
System.ClientModel.Primitives.ModelReaderWriterOptions options

The System.ClientModel.Primitives.ModelReaderWriterOptions to use.
Returns
DataflowEndpointMqtt

A T representation of the data.
Exceptions
System.FormatException

If the model does not support the requested System.ClientModel.Primitives.ModelReaderWriterOptions.Format.

IPersistableModel<DataflowEndpointMqtt>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

Declaration
string IPersistableModel<DataflowEndpointMqtt>.GetFormatFromOptions (System.ClientModel.Primitives.ModelReaderWriterOptions options);
Parameters
System.ClientModel.Primitives.ModelReaderWriterOptions options

The System.ClientModel.Primitives.ModelReaderWriterOptions to consider when serializing and deserializing the model.
Returns
System.String

The format that the model uses when communicating with the service.

IPersistableModel<DataflowEndpointMqtt>.Write(ModelReaderWriterOptions)

Writes the model into a System.BinaryData.

Declaration
BinaryData IPersistableModel<DataflowEndpointMqtt>.Write (System.ClientModel.Primitives.ModelReaderWriterOptions options);
Parameters
System.ClientModel.Primitives.ModelReaderWriterOptions options

The System.ClientModel.Primitives.ModelReaderWriterOptions to use.
Returns
System.BinaryData

A binary representation of the written model.
Exceptions
System.FormatException

If the model does not support the requested System.ClientModel.Primitives.ModelReaderWriterOptions.Format.