Class DataflowEndpointMqttAuthentication

Mqtt endpoint Authentication properties. NOTE - only authentication property is allowed per entry.

Inheritance

System.Object

DataflowEndpointMqttAuthentication

Namespace: System.Dynamic.ExpandoObject

Assembly: Azure.ResourceManager.IotOperations.dll

Syntax

public class DataflowEndpointMqttAuthentication : System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.IotOperations.Models.DataflowEndpointMqttAuthentication>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.IotOperations.Models.DataflowEndpointMqttAuthentication>

Constructors

DataflowEndpointMqttAuthentication(MqttAuthMethod)

Initializes a new instance of DataflowEndpointMqttAuthentication.

Declaration

public DataflowEndpointMqttAuthentication (Azure.ResourceManager.IotOperations.Models.MqttAuthMethod method);

Parameters

MqttAuthMethod method Mode of Authentication.

Properties

Method

Mode of Authentication.

Declaration

public Azure.ResourceManager.IotOperations.Models.MqttAuthMethod Method { get; set; }

Property Value

MqttAuthMethod

ServiceAccountTokenAudience

Audience of the service account. Optional, defaults to the broker internal service account audience.

Declaration

public string ServiceAccountTokenAudience { get; set; }

Property Value

System.String

SystemAssignedManagedIdentityAudience

Audience of the service to authenticate against. Optional; defaults to the audience for Service host configuration.

Declaration

public string SystemAssignedManagedIdentityAudience { get; set; }

Property Value

System.String

UserAssignedManagedIdentitySettings

User-assigned managed identity authentication.

Declaration

public Azure.ResourceManager.IotOperations.Models.DataflowEndpointAuthenticationUserAssignedManagedIdentity UserAssignedManagedIdentitySettings { get; set; }

Property Value

DataflowEndpointAuthenticationUserAssignedManagedIdentity

X509CertificateSecretRef

Secret reference of the X.509 certificate.

Declaration

public string X509CertificateSecretRef { get; set; }

Property Value

System.String

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<DataflowEndpointMqttAuthentication>.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.DataflowEndpointMqttAuthentication IJsonModel<DataflowEndpointMqttAuthentication>.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

DataflowEndpointMqttAuthentication A T representation of the JSON value.

Exceptions

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

IJsonModel<DataflowEndpointMqttAuthentication>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

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

Declaration

void IJsonModel<DataflowEndpointMqttAuthentication>.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<DataflowEndpointMqttAuthentication>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided System.BinaryData into a model.

Declaration

Azure.ResourceManager.IotOperations.Models.DataflowEndpointMqttAuthentication IPersistableModel<DataflowEndpointMqttAuthentication>.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

DataflowEndpointMqttAuthentication A T representation of the data.

Exceptions

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

IPersistableModel<DataflowEndpointMqttAuthentication>.GetFormatFromOptions(ModelReaderWriterOptions)

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

Declaration

string IPersistableModel<DataflowEndpointMqttAuthentication>.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<DataflowEndpointMqttAuthentication>.Write(ModelReaderWriterOptions)

Writes the model into a System.BinaryData.

Declaration

BinaryData IPersistableModel<DataflowEndpointMqttAuthentication>.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.