Class AkriConnectorsMqttConnectionConfiguration
AkriConnectorsMqttConnectionConfiguration properties.
Inheritance
Namespace: System.Dynamic.ExpandoObject
Assembly: Azure.ResourceManager.IotOperations.dll
Syntax
public class AkriConnectorsMqttConnectionConfiguration : System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.IotOperations.Models.AkriConnectorsMqttConnectionConfiguration>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.IotOperations.Models.AkriConnectorsMqttConnectionConfiguration>Constructors
AkriConnectorsMqttConnectionConfiguration()
Initializes a new instance of AkriConnectorsMqttConnectionConfiguration.
Declaration
public AkriConnectorsMqttConnectionConfiguration ();Properties
Authentication
Authentication properties. Please note AkriConnectorsMqttAuthentication is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include AkriConnectorsServiceAccountAuthentication.
Declaration
public Azure.ResourceManager.IotOperations.Models.AkriConnectorsMqttAuthentication Authentication { get; set; }Property Value
|
AkriConnectorsMqttAuthentication
|
Host
Host of the Broker in the form of <hostname>:<port>.
Declaration
public string Host { get; set; }Property Value
|
System.String
|
KeepAliveSeconds
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
The protocol to use for the connection. Currently only mqtt is supported.
Declaration
public Nullable<Azure.ResourceManager.IotOperations.Models.AkriConnectorsMqttProtocolType> Protocol { get; set; }Property Value
|
System.Nullable<AkriConnectorsMqttProtocolType>
|
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<AkriConnectorsMqttConnectionConfiguration>.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.AkriConnectorsMqttConnectionConfiguration IJsonModel<AkriConnectorsMqttConnectionConfiguration>.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
|
AkriConnectorsMqttConnectionConfiguration
A |
Exceptions
|
System.FormatException
If the model does not support the requested System.ClientModel.Primitives.ModelReaderWriterOptions.Format. |
IJsonModel<AkriConnectorsMqttConnectionConfiguration>.Write(Utf8JsonWriter, ModelReaderWriterOptions)
Writes the model to the provided System.Text.Json.Utf8JsonWriter.
Declaration
void IJsonModel<AkriConnectorsMqttConnectionConfiguration>.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<AkriConnectorsMqttConnectionConfiguration>.Create(BinaryData, ModelReaderWriterOptions)
Converts the provided System.BinaryData into a model.
Declaration
Azure.ResourceManager.IotOperations.Models.AkriConnectorsMqttConnectionConfiguration IPersistableModel<AkriConnectorsMqttConnectionConfiguration>.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
|
AkriConnectorsMqttConnectionConfiguration
A |
Exceptions
|
System.FormatException
If the model does not support the requested System.ClientModel.Primitives.ModelReaderWriterOptions.Format. |
IPersistableModel<AkriConnectorsMqttConnectionConfiguration>.GetFormatFromOptions(ModelReaderWriterOptions)
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
Declaration
string IPersistableModel<AkriConnectorsMqttConnectionConfiguration>.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<AkriConnectorsMqttConnectionConfiguration>.Write(ModelReaderWriterOptions)
Writes the model into a System.BinaryData.
Declaration
BinaryData IPersistableModel<AkriConnectorsMqttConnectionConfiguration>.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. |