DeviceManagementClient.GetInstallableUpdatesForDeviceClassesAsync メソッド

  • リファレンス

定義

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

デバイス クラスのインストール可能な更新プログラムの一覧を取得します。

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

パラメーター

deviceClassId
String

デバイス クラス識別子。

context
RequestContext

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

戻り値

AsyncPageable<BinaryData>

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

例外

ArgumentNullException

deviceClassId が null です。

ArgumentException

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

RequestFailedException

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

例

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

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.GetInstallableUpdatesForDeviceClassesAsync("<deviceClassId>"))
{
    JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement;
    Console.WriteLine(result.GetProperty("updateId").GetProperty("provider").ToString());
    Console.WriteLine(result.GetProperty("updateId").GetProperty("name").ToString());
    Console.WriteLine(result.GetProperty("updateId").GetProperty("version").ToString());
    Console.WriteLine(result.GetProperty("description").ToString());
    Console.WriteLine(result.GetProperty("friendlyName").ToString());
}

注釈

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

応答本文:

の UpdateInfoListValueスキーマ:

{
              updateId: {
                provider: string, # Required. Update provider.
                name: string, # Required. Update name.
                version: string, # Required. Update version.
              }, # Required. Update identifier.
              description: string, # Optional. Update description.
              friendlyName: string, # Optional. Friendly update name.
            }

適用対象