Class ManagementActionInvokedEventArgs

Namespace

Azure.Iot.Operations.Connector

Assembly

Azure.Iot.Operations.Connector.dll

Event arguments passed to HandleAsync(ManagementActionInvokedEventArgs, CancellationToken) when a management action is invoked. Contains the full request context so the handler can execute the appropriate device operation.

public class ManagementActionInvokedEventArgs : EventArgs

Inheritance

object

EventArgs

ManagementActionInvokedEventArgs

Inherited Members

EventArgs.Empty

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

The action's ActionType is surfaced here (rather than via separate handler methods) because the SDK treats Call / Read / Write invocations symmetrically. Handlers that need to behave differently per type can branch on ActionType.

Properties

ActionName

The management action name.

public required string ActionName { get; init; }

Property Value

string

ActionType

The action type (Call, Read, or Write) as declared on the management action definition. Fixed for the lifetime of the action — does not vary per request.

public required AssetManagementGroupActionType ActionType { get; init; }

Property Value

AssetManagementGroupActionType

AssetName

The name of the asset that this action belongs to.

public required string AssetName { get; init; }

Property Value

string

ContentType

MIME type of Payload.

public required string ContentType { get; init; }

Property Value

string

CustomUserData

MQTT 5 user properties sent by the invoker.

public IReadOnlyDictionary<string, string> CustomUserData { get; init; }

Property Value

IReadOnlyDictionary<string, string>

DeviceName

The name of the device that the asset belongs to.

public required string DeviceName { get; init; }

Property Value

string

FormatIndicator

MQTT 5 payload format indicator reported by the invoker.

public MqttPayloadFormatIndicator FormatIndicator { get; init; }

Property Value

MqttPayloadFormatIndicator

GroupName

The management group name this action belongs to.

public required string GroupName { get; init; }

Property Value

string

InvokerId

Invoker identity as surfaced by the broker / auth policy, if any.

public string? InvokerId { get; init; }

Property Value

string

Payload

Raw request payload bytes as delivered by the invoker.

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

Property Value

ReadOnlySequence<byte>

Timestamp

HLC timestamp from the invoker, if present.

public HybridLogicalClock? Timestamp { get; init; }

Property Value

HybridLogicalClock

TopicTokens

Values extracted from wildcard segments of the action request topic pattern.

public IReadOnlyDictionary<string, string> TopicTokens { get; init; }

Property Value

IReadOnlyDictionary<string, string>