Class ConnectorEdgeRegistryMessageSchema

Namespace

Azure.Iot.Operations.Connector

Assembly

Azure.Iot.Operations.Connector.dll

A message schema to register with the Edge Registry as a Schema Version.

public class ConnectorEdgeRegistryMessageSchema

Inheritance

object

ConnectorEdgeRegistryMessageSchema

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

ConnectorEdgeRegistryMessageSchema(string, SchemaVersionAttributes, IReadOnlyList<Label>?, GroupId)

public ConnectorEdgeRegistryMessageSchema(string schemaId, SchemaVersionAttributes version, IReadOnlyList<Label>? schemaLabels = null, GroupId groupId = default)

Parameters

schemaId string

version SchemaVersionAttributes

schemaLabels IReadOnlyList<Label>

groupId GroupId

Properties

GroupId

The Schema Group to store the schema under.

public GroupId GroupId { get; }

Property Value

GroupId

SchemaId

The Schema to store the Version under. Use Derive(string, IReadOnlyList<Label>?) to turn an arbitrary identifier into a valid Resource identifier.

public string SchemaId { get; }

Property Value

string

SchemaLabels

Queryable key/value pairs to add to the parent Schema.

public IReadOnlyList<Label> SchemaLabels { get; }

Property Value

IReadOnlyList<Label>

Version

The attributes of the Schema Version to create.

public SchemaVersionAttributes Version { get; }

Property Value

SchemaVersionAttributes

Methods

DefaultDatasetSchemaId(string, string, string, string)

Builds the identifier that uniquely describes the schema of a dataset. Pass it through Derive(string, IReadOnlyList<Label>?) to turn it into a valid Resource identifier.

public static string DefaultDatasetSchemaId(string deviceName, string inboundEndpointName, string assetName, string datasetName)

Parameters

deviceName string

inboundEndpointName string

assetName string

datasetName string

Returns

string

DefaultEventSchemaId(string, string, string, string, string)

Builds the identifier that uniquely describes the schema of an event. Pass it through Derive(string, IReadOnlyList<Label>?) to turn it into a valid Resource identifier.

public static string DefaultEventSchemaId(string deviceName, string inboundEndpointName, string assetName, string eventGroupName, string eventName)

Parameters

deviceName string

inboundEndpointName string

assetName string

eventGroupName string

eventName string

Returns

string