Interface IMessageSchemaProvider

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

public interface IMessageSchemaProvider

Remarks

NoMessageSchemaProvider can be used if you do not want to register any message schemas for your datasets or events.

Methods

GetMessageSchemaAsync(AssetEndpointProfile, Asset, string, Dataset, 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<ConnectorMessageSchema?> GetMessageSchemaAsync(AssetEndpointProfile assetEndpointProfile, Asset asset, string datasetName, Dataset dataset, CancellationToken cancellationToken = default)

Parameters

assetEndpointProfile AssetEndpointProfile

The asset endpoint profile this dataset will be sampled from.

asset Asset

The asset this dataset belongs to.

datasetName string

The name of the dataset.

dataset Dataset

The dataset.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ConnectorMessageSchema>

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

GetMessageSchemaAsync(AssetEndpointProfile, Asset, string, Event, 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<ConnectorMessageSchema?> GetMessageSchemaAsync(AssetEndpointProfile assetEndpointProfile, Asset asset, string eventName, Event assetEvent, CancellationToken cancellationToken = default)

Parameters

assetEndpointProfile AssetEndpointProfile

The asset endpoint profile this event will be received from.

asset Asset

The asset this event belongs to.

eventName string

The name of the event.

assetEvent Event

The event

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ConnectorMessageSchema>

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