DeviceUpdateClient.GetFilesAsync メソッド

  • リファレンス

定義

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

指定したバージョンのすべての更新ファイル識別子の一覧を取得します。

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

パラメーター

provider
String

プロバイダーを更新します。

name
String

更新名。

version
String

バージョンを更新します。

context
RequestContext

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

戻り値

AsyncPageable<BinaryData>

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

例外

ArgumentNullException

provider、name、または version が null です。

ArgumentException

provider、 name または version は空の文字列であり、空でないと想定されていました。

RequestFailedException

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

例

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

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

await foreach (var data in client.GetFilesAsync("<provider>", "<name>", "<version>"))
{
    JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement;
    Console.WriteLine(result.ToString());
}

注釈

の Response Bodyスキーマ:

{
              value: [string],
              nextLink: string
            }

の Response Errorスキーマ:

{
              error: {
                code: string,
                message: string,
                target: string,
                details: [Error],
                innererror: {
                  code: string,
                  message: string,
                  errorDetail: string,
                  innerError: InnerError
                },
                occurredDateTime: string (ISO 8601 Format)
              }
            }

適用対象