Class Group

Namespace

Azure.Iot.Operations.Services.EdgeRegistry.Generated

Assembly

Azure.Iot.Operations.Services.dll

A Group entity — container for related Resources.

public class Group : IJsonOnDeserialized, IJsonOnSerializing

Inheritance

object

Group

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

CreatedAt

The date/time of when the entity was created.

[JsonPropertyName("createdAt")]
[JsonIgnore(Condition = JsonIgnoreCondition.Never)]
[JsonRequired]
public DateTime CreatedAt { get; set; }

Property Value

DateTime

Deprecated

Information about deprecation status of the entity, if applicable.

[JsonPropertyName("deprecated")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public DeprecatedInfo? Deprecated { get; set; }

Property Value

DeprecatedInfo

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

Documentation

A URL to additional information about this entity.

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

Property Value

string

Epoch

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

[JsonPropertyName("epoch")]
[JsonIgnore(Condition = JsonIgnoreCondition.Never)]
[JsonRequired]
public ulong Epoch { get; set; }

Property Value

ulong

Extensions

Extension-specific attributes (e.g., envelope, protocol for message Groups).

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

Property Value

Dictionary<string, byte[]>

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

Id

Group identifier.

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

Property Value

string

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.

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

Property Value

List<Label>

ModifiedAt

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

[JsonPropertyName("modifiedAt")]
[JsonIgnore(Condition = JsonIgnoreCondition.Never)]
[JsonRequired]
public DateTime ModifiedAt { get; set; }

Property Value

DateTime

Name

Human-readable name.

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

Property Value

string

ResourcesCounts

Map of the count of each Resource type contained within this Group, keyed by Resource type.

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

Property Value

Dictionary<string, ulong>

Xid

Full XID path, e.g. /schemagroups/mygroup

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

Property Value

string