DeviceManagementClient.GetGroups(String, RequestContext) Methode

Definition

Namespace:

Azure.IoT.DeviceUpdate

Assembly:

Azure.IoT.DeviceUpdate.dll

Paket:

Azure.IoT.DeviceUpdate v1.0.0

Quelle:

DeviceManagementClient.cs

Ruft eine Liste aller Gerätegruppen ab. Die $default Gruppe wird immer zuerst zurückgegeben.

public virtual Azure.Pageable<BinaryData> GetGroups (string orderBy = default, Azure.RequestContext context = default);

abstract member GetGroups : string * Azure.RequestContext -> Azure.Pageable<BinaryData>
override this.GetGroups : string * Azure.RequestContext -> Azure.Pageable<BinaryData>

Public Overridable Function GetGroups (Optional orderBy As String = Nothing, Optional context As RequestContext = Nothing) As Pageable(Of BinaryData)

Parameter

orderBy

String

Ordnet den zurückgegebenen Gruppensatz an. Sie können nach groupId, deviceCount, createdDate, subgroupsWithNewUpdatesAvailableCount, UntergruppenWithUpdatesInProgressCount oder UntergruppenOnLatestUpdateCount sortieren.

context

RequestContext

Der Anforderungskontext, der das Standardverhalten der Clientpipeline pro Aufruf außer Kraft setzen kann.

Gibt zurück

Pageable<BinaryData>

Die Pageable<T> aus dem Dienst, die eine Liste von BinaryData -Objekten enthält. Details zum Textschema für jedes Element in der Auflistung finden Sie unten im Abschnitt Hinweise.

Ausnahmen

RequestFailedException

Der Dienst hat einen nicht erfolgreichen status Code zurückgegeben.

Beispiele

In diesem Beispiel wird gezeigt, wie GetGroups aufgerufen und das Ergebnis analysiert wird.

var credential = new DefaultAzureCredential();
var endpoint = new Uri("<https://my-service.azure.com>");
var client = new DeviceManagementClient(endpoint, "<instanceId>", credential);

foreach (var data in client.GetGroups())
{
    JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement;
    Console.WriteLine(result.GetProperty("groupId").ToString());
    Console.WriteLine(result.GetProperty("groupType").ToString());
    Console.WriteLine(result.GetProperty("createdDateTime").ToString());
}

In diesem Beispiel wird gezeigt, wie GetGroups mit allen Parametern aufgerufen und das Ergebnis analysiert wird.

var credential = new DefaultAzureCredential();
var endpoint = new Uri("<https://my-service.azure.com>");
var client = new DeviceManagementClient(endpoint, "<instanceId>", credential);

foreach (var data in client.GetGroups("<orderBy>"))
{
    JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement;
    Console.WriteLine(result.GetProperty("groupId").ToString());
    Console.WriteLine(result.GetProperty("groupType").ToString());
    Console.WriteLine(result.GetProperty("createdDateTime").ToString());
    Console.WriteLine(result.GetProperty("deviceCount").ToString());
    Console.WriteLine(result.GetProperty("subgroupsWithNewUpdatesAvailableCount").ToString());
    Console.WriteLine(result.GetProperty("subgroupsWithUpdatesInProgressCount").ToString());
    Console.WriteLine(result.GetProperty("subgroupsWithOnLatestUpdateCount").ToString());
    Console.WriteLine(result.GetProperty("deployments")[0].ToString());
}

Hinweise

Unten sehen Sie das JSON-Schema für ein Element in der auslagerungsfähigen Antwort.

Antworttext:

Schema für GroupsListValue:

{
              groupId: string, # Required. Group identity. This is created from the value of the ADUGroup tag in the Iot Hub's device/module twin or $default for devices with no tag.
              groupType: "IoTHubTag" | "DefaultNoTag", # Required. Group type.
              createdDateTime: string, # Required. Date and time when the update was created.
              deviceCount: number, # Optional. The number of devices in the group.
              subgroupsWithNewUpdatesAvailableCount: number, # Optional. The count of subgroups with new updates available.
              subgroupsWithUpdatesInProgressCount: number, # Optional. The count of subgroups with updates in progress.
              subgroupsWithOnLatestUpdateCount: number, # Optional. The count of subgroups with devices on the latest update.
              deployments: [string], # Optional. The active deployment Ids for the group
            }