Event interface

Package:

@azure/arm-deviceregistry

Defines the event properties.

Properties

capabilityId	The path to the type definition of the capability (e.g. DTMI, OPC UA information model node id, etc.), for example dtmi:com:example:Robot:_contents:__prop1;1.
eventConfiguration	Protocol-specific configuration for the event. For OPC UA, this could include configuration like, publishingInterval, samplingInterval, and queueSize.
eventNotifier	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.
name	The name of the event.
observabilityMode	An indication of how the event should be mapped to OpenTelemetry.

Property Details

capabilityId

The path to the type definition of the capability (e.g. DTMI, OPC UA information model node id, etc.), for example dtmi:com:example:Robot:_contents:__prop1;1.

capabilityId?: string

Property Value

string

eventConfiguration

Protocol-specific configuration for the event. For OPC UA, this could include configuration like, publishingInterval, samplingInterval, and queueSize.

eventConfiguration?: string

Property Value

string

eventNotifier

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.

eventNotifier: string

Property Value

string

name

The name of the event.

name?: string

Property Value

string

observabilityMode

An indication of how the event should be mapped to OpenTelemetry.

observabilityMode?: string

Property Value

string