Class ListResourcesRequestPayload

Namespace

Azure.Iot.Operations.Services.EdgeRegistry.Generated

Assembly

Azure.Iot.Operations.Services.dll

Request payload for listing xRegistry Resources, optionally filtered by Group type, Group, Resource type, and/or label.

public class ListResourcesRequestPayload

Inheritance

object

ListResourcesRequestPayload

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

AllGroups

If true, lists Resources across all Groups (groupId is ignored). If false, lists within the Group specified by groupId, or — only when groupType is specified — the default Group of that type if groupId is unspecified.

[JsonPropertyName("allGroups")]
[JsonIgnore(Condition = JsonIgnoreCondition.Never)]
[JsonRequired]
public bool AllGroups { get; set; }

Property Value

bool

GroupId

Group identifier. Ignored if allGroups is true. If not specified, the default Group of the specified groupType is used; this default is only valid when groupType is specified, so groupId must be provided when groupType is not.

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

Property Value

string

GroupType

Group type. If not specified, Resources are listed across all Group types; in that case groupId must be specified explicitly or allGroups must be true, because the default Group only exists within a specific Group type.

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

Property Value

string

Label

If specified, only Resources with this label are listed.

[JsonPropertyName("label")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public Label? Label { get; set; }

Property Value

Label

ResourceType

Resource type. If specified, only Resources of this type are listed; when listing across all Groups, Resources of this type are matched across all Groups. Lists Resources across all Resource types if not specified.

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

Property Value

string