Class ManagementActionResponse

Namespace

Azure.Iot.Operations.Connector

Assembly

Azure.Iot.Operations.Connector.dll

Response to a management action invocation. Returned from the Azure.Iot.Operations.Connector.ManagementActionExecutor.OnRequestReceived callback (or, in connector-worker scenarios, from one of the IManagementActionHandler handler methods); the SDK ships it to the invoker.

public record ManagementActionResponse : IEquatable<ManagementActionResponse>

Inheritance

object

ManagementActionResponse

Implements

IEquatable<ManagementActionResponse>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

ApplicationError

If set, the response represents an application-level failure. The connector reports this via the RPC application-error mechanism rather than a successful response; Payload may be empty in that case.

public ManagementActionApplicationError? ApplicationError { get; init; }

Property Value

ManagementActionApplicationError

CloudEvent

Optional CloudEvent metadata to attach to the response. Defaults to null (no CloudEvent attached).

public CloudEvent? CloudEvent { get; init; }

Property Value

CloudEvent

ContentType

MIME type of Payload (e.g. application/json).

public required string ContentType { get; init; }

Property Value

string

CustomUserData

Additional MQTT 5 user properties to attach to the response.

public Dictionary<string, string>? CustomUserData { get; init; }

Property Value

Dictionary<string, string>

FormatIndicator

MQTT 5 payload format indicator. Defaults to raw bytes.

public MqttPayloadFormatIndicator FormatIndicator { get; init; }

Property Value

MqttPayloadFormatIndicator

Payload

Serialized response payload.

public required ReadOnlySequence<byte> Payload { get; init; }

Property Value

ReadOnlySequence<byte>