Class Schema

Namespace

Azure.Iot.Operations.Services.SchemaRegistry.SchemaRegistry

Assembly

Azure.Iot.Operations.Services.dll

Schema object

public class Schema : IJsonOnDeserialized, IJsonOnSerializing

Inheritance

object

Schema

Implements

IJsonOnDeserialized

IJsonOnSerializing

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Description

Human-readable description of the schema.

[JsonPropertyName("description")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public string? Description { get; set; }

Property Value

string

DisplayName

Human-readable display name.

[JsonPropertyName("displayName")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public string? DisplayName { get; set; }

Property Value

string

Format

Format of the schema.

[JsonPropertyName("format")]
[JsonIgnore(Condition = JsonIgnoreCondition.Never)]
[JsonRequired]
public Format Format { get; set; }

Property Value

Format

Hash

Hash of the schema content.

[JsonPropertyName("hash")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public string? Hash { get; set; }

Property Value

string

Name

Schema name.

[JsonPropertyName("name")]
[JsonIgnore(Condition = JsonIgnoreCondition.Never)]
[JsonRequired]
public string Name { get; set; }

Property Value

string

Namespace

Schema registry namespace. Uniquely identifies a schema registry within a tenant.

[JsonPropertyName("namespace")]
[JsonIgnore(Condition = JsonIgnoreCondition.Never)]
[JsonRequired]
public string Namespace { get; set; }

Property Value

string

SchemaContent

Content stored in the schema.

[JsonPropertyName("schemaContent")]
[JsonIgnore(Condition = JsonIgnoreCondition.Never)]
[JsonRequired]
public string SchemaContent { get; set; }

Property Value

string

SchemaType

Type of the schema.

[JsonPropertyName("schemaType")]
[JsonIgnore(Condition = JsonIgnoreCondition.Never)]
[JsonRequired]
public SchemaType SchemaType { get; set; }

Property Value

SchemaType

Tags

Schema tags.

[JsonPropertyName("tags")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public Dictionary<string, string>? Tags { get; set; }

Property Value

Dictionary<string, string>

Version

Version of the schema. Allowed between 0-9.

[JsonPropertyName("version")]
[JsonIgnore(Condition = JsonIgnoreCondition.Never)]
[JsonRequired]
public string Version { get; set; }

Property Value

string