Class GroupAttributes

Namespace

Azure.Iot.Operations.Services.EdgeRegistry.Generated

Assembly

Azure.Iot.Operations.Services.dll

Request payload for creating or updating a Group.

public class GroupAttributes : IJsonOnDeserialized, IJsonOnSerializing

Inheritance

object

GroupAttributes

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

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

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[]>

GroupId

Group identifier.

[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

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>

Name

Human-readable name.

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

Property Value

string