Class CreateSchemaVersionAttributes

Namespace

Azure.Iot.Operations.Services.EdgeRegistry.Generated

Assembly

Azure.Iot.Operations.Services.dll

Request payload for creating a Schema Version.

public class CreateSchemaVersionAttributes : IJsonOnDeserialized, IJsonOnSerializing

Inheritance

object

CreateSchemaVersionAttributes

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

Ancestor

The versionId of this Version's ancestor if it has an ancestor.

[JsonPropertyName("ancestor")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public ulong? Ancestor { get; set; }

Property Value

ulong?

ContentType

The media type of the entity as defined by RFC9110.

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

Property Value

string

Description

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

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

Property Value

string

Document

Base64-encoded schema document content.

[JsonPropertyName("document")]
[JsonIgnore(Condition = JsonIgnoreCondition.Never)]
[JsonRequired]
public byte[] Document { get; set; }

Property Value

byte[]

Documentation

A URL to additional information about this entity.

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

Property Value

string

Extensions

Extension-specific attributes.

[JsonPropertyName("extensions")]
[JsonIgnore(Condition = JsonIgnoreCondition.Never)]
[JsonRequired]
public Dictionary<string, byte[]> Extensions { get; set; }

Property Value

Dictionary<string, byte[]>

Format

Schema format identifier.

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

Property Value

string

GroupId

Group identifier. Uses the default if not specified.

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

Property Value

string

Icon

A URL to a graphical icon for the owning entity.

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

Property Value

string

Labels

Queryable Key Value pairs to be added to the Version. Labels can be used to store additional metadata about the Version.

[JsonPropertyName("labels")]
[JsonIgnore(Condition = JsonIgnoreCondition.Never)]
[JsonRequired]
public List<Label> Labels { get; set; }

Property Value

List<Label>

Name

Human-readable name.

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

Property Value

string

SchemaLabels

Queryable Key Value pairs to be added to the parent Schema. Labels can be used to store additional metadata about the Schema.

[JsonPropertyName("schemaLabels")]
[JsonIgnore(Condition = JsonIgnoreCondition.Never)]
[JsonRequired]
public List<Label> SchemaLabels { get; set; }

Property Value

List<Label>