Event Class

Definition

Namespace:: Microsoft.Azure.PowerShell.Cmdlets.DeviceRegistry.Models

Assembly:: Az.DeviceRegistry.private.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Defines the event properties.

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.DeviceRegistry.Models.EventTypeConverter))]
public class Event : Microsoft.Azure.PowerShell.Cmdlets.DeviceRegistry.Models.IEvent, Microsoft.Azure.PowerShell.Cmdlets.DeviceRegistry.Runtime.IValidates

[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.DeviceRegistry.Models.EventTypeConverter))>]
type Event = class
    interface IEvent
    interface IJsonSerializable
    interface IEventBase
    interface IValidates

Public Class Event
Implements IEvent, IValidates

Inheritance: Object
Event

Attributes: TypeConverterAttribute

Implements: IEvent IEventBase IJsonSerializable IValidates

Constructors

Name	Description
Event()	Creates an new Event instance.

Properties

Name	Description
Configuration	Stringified JSON that contains connector-specific configuration for the event. For OPC UA, this could include configuration like, publishingInterval, samplingInterval, and queueSize.
Name	The name of the event.
Notifier	The address of the notifier of the event in the asset (e.g. URL) so that a client can access the event on the asset.
ObservabilityMode	An indication of how the event should be mapped to OpenTelemetry.
TopicPath	The topic path for messages published to an MQTT broker.
TopicRetain	When set to 'Keep', messages published to an MQTT broker will have the retain flag set. Default: 'Never'.

Methods

Name	Description
DeserializeFromDictionary(IDictionary)	Deserializes a IDictionary into an instance of Event.
DeserializeFromPSObject(PSObject)	Deserializes a PSObject into an instance of Event.
FromJson(JsonNode)	Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.DeviceRegistry.Models.IEvent.
FromJsonString(String)	Creates a new instance of Event, deserializing the content from a json string.
ToJson(JsonObject, SerializationMode)	Serializes this instance of Event into a JsonNode.
ToJsonString()	Serializes this instance to a json string.
ToString()
Validate(IEventListener)	Validates that this object meets the validation criteria.

Applies to