Class SchemaVersion

Namespace

Azure.Iot.Operations.Services.EdgeRegistry.Models

Assembly

Azure.Iot.Operations.Services.dll

A specific Version of a Schema. Self-contained: combines the generic Version fields and the schema-specific fields, with integer-typed VersionId and Ancestor.

public class SchemaVersion

Inheritance

object

SchemaVersion

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Ancestor

The versionId of this Version's ancestor, or this Version's versionId if it has no ancestor.

public required ulong Ancestor { get; set; }

Property Value

ulong

CompatibilityValidated

When compatibility validation is enabled, indicates whether the server has validated that the Version conforms to the rules defined by its Schema's compatibility attribute.

public ValidationStatus? CompatibilityValidated { get; set; }

Property Value

ValidationStatus

ContentType

The media type of the entity as defined by RFC9110.

public string? ContentType { get; set; }

Property Value

string

CreatedAt

The date/time of when the entity was created.

public required DateTime CreatedAt { get; set; }

Property Value

DateTime

Description

A human-readable summary of the purpose of the entity.

public string? Description { get; set; }

Property Value

string

Document

The raw schema document for this Version.

public required byte[] Document { get; set; }

Property Value

byte[]

DocumentHash

The hash of the schema document for this Version.

public required string DocumentHash { get; set; }

Property Value

string

Documentation

A URL to additional information about this entity.

public string? Documentation { get; set; }

Property Value

string

Epoch

A numeric value used to determine whether an entity has been modified.

public required ulong Epoch { get; set; }

Property Value

ulong

Extensions

Extension-specific attributes.

public required Dictionary<string, byte[]> Extensions { get; set; }

Property Value

Dictionary<string, byte[]>

Format

Identifies the format of the schema document.

public required SchemaFormat Format { get; set; }

Property Value

SchemaFormat

FormatValidated

When format validation is enabled, indicates whether the server has validated that the Version conforms to the rules defined by its Format.

public ValidationStatus? FormatValidated { get; set; }

Property Value

ValidationStatus

Icon

A URL to a graphical icon for the owning entity.

public string? Icon { get; set; }

Property Value

string

IsDefault

Indicates whether this Version is the default Version of the owning Schema.

public required bool IsDefault { get; set; }

Property Value

bool

Labels

A mechanism in which additional metadata about the entity can be stored without changing the model definition of the entity. Labels can be used for querying.

public required List<Label> Labels { get; set; }

Property Value

List<Label>

ModifiedAt

The date/time of when the entity was last updated.

public required DateTime ModifiedAt { get; set; }

Property Value

DateTime

Name

Human-readable name.

public string? Name { get; set; }

Property Value

string

ResourceId

Schema (Resource) identifier.

public required string ResourceId { get; set; }

Property Value

string

VersionId

Version identifier.

public required ulong VersionId { get; set; }

Property Value

ulong

XId

Full XID path.

public required string XId { get; set; }

Property Value

string