次の方法で共有

DeviceManagementClient.GetDeviceStatesForDeviceClassSubgroupDeployments メソッド

  • リファレンス

定義

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

展開中のデバイスとその状態の一覧を取得します。 失敗したデバイスの一覧を取得するのに役立ちます。

public virtual Azure.Pageable<BinaryData> GetDeviceStatesForDeviceClassSubgroupDeployments (string groupId, string deviceClassId, string deploymentId, string filter = default, Azure.RequestContext context = default);
abstract member GetDeviceStatesForDeviceClassSubgroupDeployments : string * string * string * string * Azure.RequestContext -> Azure.Pageable<BinaryData>
override this.GetDeviceStatesForDeviceClassSubgroupDeployments : string * string * string * string * Azure.RequestContext -> Azure.Pageable<BinaryData>
Public Overridable Function GetDeviceStatesForDeviceClassSubgroupDeployments (groupId As String, deviceClassId As String, deploymentId As String, Optional filter As String = Nothing, Optional context As RequestContext = Nothing) As Pageable(Of BinaryData)

パラメーター

groupId
String

グループ識別子。

deviceClassId
String

デバイス クラス識別子。

deploymentId
String

デプロイ識別子。

filter
String

返される展開デバイスの状態のセットを制限します。 deviceId と moduleId または deviceState でフィルター処理できます。

context
RequestContext

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

戻り値

Pageable<BinaryData>

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

例外

ArgumentNullException

groupId、deviceClassId、または deploymentId が null です。

ArgumentException

groupId、 deviceClassId または deploymentId は空の文字列であり、空でないと想定されていました。

RequestFailedException

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

例

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

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.GetDeviceStatesForDeviceClassSubgroupDeployments("<groupId>", "<deviceClassId>", "<deploymentId>"))
{
    JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement;
    Console.WriteLine(result.GetProperty("deviceId").ToString());
    Console.WriteLine(result.GetProperty("retryCount").ToString());
    Console.WriteLine(result.GetProperty("movedOnToNewDeployment").ToString());
    Console.WriteLine(result.GetProperty("deviceState").ToString());
}

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

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.GetDeviceStatesForDeviceClassSubgroupDeployments("<groupId>", "<deviceClassId>", "<deploymentId>", "<filter>"))
{
    JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement;
    Console.WriteLine(result.GetProperty("deviceId").ToString());
    Console.WriteLine(result.GetProperty("moduleId").ToString());
    Console.WriteLine(result.GetProperty("retryCount").ToString());
    Console.WriteLine(result.GetProperty("movedOnToNewDeployment").ToString());
    Console.WriteLine(result.GetProperty("deviceState").ToString());
}

注釈

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

応答本文:

の DeploymentDeviceStatesListValueスキーマ:

{
              deviceId: string, # Required. Device identity.
              moduleId: string, # Optional. Device module identity.
              retryCount: number, # Required. The number of times this deployment has been retried on this device.
              movedOnToNewDeployment: boolean, # Required. Boolean flag indicating whether this device is in a newer deployment and can no longer retry this deployment.
              deviceState: "Succeeded" | "InProgress" | "Canceled" | "Failed", # Required. Deployment device state.
            }

適用対象