DeviceManagementClient.GetDeviceClassSubgroupsForGroupsAsync Methode

Referenz

Definition

Namespace:: Azure.IoT.DeviceUpdate

Assembly:: Azure.IoT.DeviceUpdate.dll

Paket:: Azure.IoT.DeviceUpdate v1.0.0

Quelle:: DeviceManagementClient.cs

Wichtig

Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.

Rufen Sie die Geräteklassenuntergruppen für die Gruppe ab. Eine Geräteklassenuntergruppe ist die Gruppe von Geräten innerhalb der Gruppe, die dieselbe Geräteklasse verwenden. Alle Geräte innerhalb derselben Geräteklasse sind mit denselben Updates kompatibel.

public virtual Azure.AsyncPageable<BinaryData> GetDeviceClassSubgroupsForGroupsAsync (string groupId, string filter = default, Azure.RequestContext context = default);

abstract member GetDeviceClassSubgroupsForGroupsAsync : string * string * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>
override this.GetDeviceClassSubgroupsForGroupsAsync : string * string * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>

Public Overridable Function GetDeviceClassSubgroupsForGroupsAsync (groupId As String, Optional filter As String = Nothing, Optional context As RequestContext = Nothing) As AsyncPageable(Of BinaryData)

Parameter

groupId: String

Gruppen-ID.

filter: String

Schränkt den Satz der zurückgegebenen Geräteklassenuntergruppen ein. Sie können nach Compat-Eigenschaften nach Name und Wert filtern. (d. h. filter=compatProperties/propertyName1 eq 'value1' und compatProperties/propertyName2 eq 'value2').

context: RequestContext

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

Gibt zurück

AsyncPageable<BinaryData>

Die AsyncPageable<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

ArgumentNullException

groupId ist NULL.

ArgumentException

groupId ist eine leere Zeichenfolge und wurde erwartet, dass sie nicht leer ist.

RequestFailedException

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

Beispiele

In diesem Beispiel wird gezeigt, wie GetDeviceClassSubgroupsForGroupsAsync mit den erforderlichen 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);

await foreach (var data in client.GetDeviceClassSubgroupsForGroupsAsync("<groupId>"))
{
    JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement;
    Console.WriteLine(result.GetProperty("deviceClassId").ToString());
    Console.WriteLine(result.GetProperty("groupId").ToString());
    Console.WriteLine(result.GetProperty("createdDateTime").ToString());
}

In diesem Beispiel wird gezeigt, wie GetDeviceClassSubgroupsForGroupsAsync 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);

await foreach (var data in client.GetDeviceClassSubgroupsForGroupsAsync("<groupId>", "<filter>"))
{
    JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement;
    Console.WriteLine(result.GetProperty("deviceClassId").ToString());
    Console.WriteLine(result.GetProperty("groupId").ToString());
    Console.WriteLine(result.GetProperty("createdDateTime").ToString());
    Console.WriteLine(result.GetProperty("deviceCount").ToString());
    Console.WriteLine(result.GetProperty("deploymentId").ToString());
}

Hinweise

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

Antworttext:

Schema für DeviceClassSubgroupsListValue:

{
              deviceClassId: string, # Required. Device class subgroup identity. This is generated from the model Id and the compat properties reported by the device update agent in the Device Update PnP interface in IoT Hub. It is a hex-encoded SHA1 hash.
              groupId: string, # Required. Group identity.
              createdDateTime: string, # Required. Date and time when the device class subgroup was created.
              deviceCount: number, # Optional. The number of devices in the device class subgroup.
              deploymentId: string, # Optional. The active deployment Id for the device class subgroup.
            }

Gilt für:

Freigeben über