Interface IEdgeRegistryMessageSchemaProvider

Namespace

Azure.Iot.Operations.Connector

Assembly

Azure.Iot.Operations.Connector.dll

The interface for a connector to request message schema information about datasets and/or events that is registered with the Edge Registry rather than the Schema Registry.

public interface IEdgeRegistryMessageSchemaProvider

Remarks

Provide an implementation of this interface instead of IMessageSchemaProvider when your deployment of AIO has the Edge Registry service. When both are provided, this one wins.

Methods

GetMessageSchemaAsync(string, Device, string, string, Asset, string, AssetDataset, CancellationToken)

Get the message schema associated with this dataset. If provided, the connector will register this message schema prior to forwarding any dataset telemetry for this dataset.

Task<ConnectorEdgeRegistryMessageSchema?> GetMessageSchemaAsync(string deviceName, Device device, string inboundEndpointName, string assetName, Asset asset, string datasetName, AssetDataset dataset, CancellationToken cancellationToken = default)

Parameters

deviceName string

The name of the device this dataset will be sampled from.

device Device

The device this dataset will be sampled from.

inboundEndpointName string

The name of the inbound endpoint this dataset will be sampled from.

assetName string

The name of the asset this dataset belongs to.

asset Asset

The asset this dataset belongs to.

datasetName string

The name of the dataset.

dataset AssetDataset

The dataset.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ConnectorEdgeRegistryMessageSchema>

The message schema to register for data sampled from this dataset. If null, no message schema will be registered for this dataset.

GetMessageSchemaAsync(string, Device, string, string, Asset, string, string, AssetEvent, CancellationToken)

Get the message schema associated with this event. If provided, the connector will register this message schema prior to forwarding any event telemetry for this event.

Task<ConnectorEdgeRegistryMessageSchema?> GetMessageSchemaAsync(string deviceName, Device device, string inboundEndpointName, string assetName, Asset asset, string eventGroupName, string eventName, AssetEvent assetEvent, CancellationToken cancellationToken = default)

Parameters

deviceName string

The name of the device this event will be received from.

device Device

The device this event will be received from.

inboundEndpointName string

The name of the inbound endpoint this event will be received from.

assetName string

The name of the asset this event belongs to.

asset Asset

The asset this event belongs to.

eventGroupName string

The name of the event group the event belongs to.

eventName string

The name of the event.

assetEvent AssetEvent

The event

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ConnectorEdgeRegistryMessageSchema>

The message schema to register for data received from this event. If null, no message schema will be registered for this event.