次の方法で共有

DeviceManagementClient.GetGroups(String, RequestContext) メソッド

  • リファレンス

定義

名前空間:
Azure.IoT.DeviceUpdate
アセンブリ:
Azure.IoT.DeviceUpdate.dll
パッケージ:
Azure.IoT.DeviceUpdate v1.0.0
ソース:
DeviceManagementClient.cs

すべてのデバイス グループの一覧を取得します。 $default グループは常に最初に返されます。

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)

パラメーター

orderBy
String

返されるグループのセットを注文します。 groupId、deviceCount、createdDate、サブグループWithNewUpdatesAvailableCount、サブグループWithUpdatesInProgressCount、またはサブグループOnLatestUpdateCountで並べ替えることができます。

context
RequestContext

要求コンテキスト。これは、呼び出しごとにクライアント パイプラインの既定の動作をオーバーライドできます。

戻り値

Pageable<BinaryData>

Pageable<T>オブジェクトの一覧を含むサービスの BinaryData 。 コレクション内の各項目の本文スキーマの詳細については、以下の「解説」セクションを参照してください。

例外

RequestFailedException

サービスから成功以外の状態コードが返されました。

例

このサンプルでは、GetGroups を呼び出して結果を解析する方法を示します。

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());
}

このサンプルでは、すべてのパラメーターを使用して GetGroups を呼び出す方法と、結果を解析する方法を示します。

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());
}

注釈

ページング可能な応答の 1 つの項目の JSON スキーマを次に示します。

応答本文:

の 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
            }

適用対象