DeviceUpdateClient.GetVersions(String, String, String, RequestContext) メソッド

定義

名前空間:

Azure.IoT.DeviceUpdate

アセンブリ:

Azure.IoT.DeviceUpdate.dll

パッケージ:

Azure.IoT.DeviceUpdate v1.0.0

ソース:

DeviceUpdateClient.cs

指定したプロバイダーと名前に一致するすべての更新バージョンの一覧を取得します。

public virtual Azure.Pageable<BinaryData> GetVersions (string provider, string name, string filter = default, Azure.RequestContext context = default);

abstract member GetVersions : string * string * string * Azure.RequestContext -> Azure.Pageable<BinaryData>
override this.GetVersions : string * string * string * Azure.RequestContext -> Azure.Pageable<BinaryData>

Public Overridable Function GetVersions (provider As String, name As String, Optional filter As String = Nothing, Optional context As RequestContext = Nothing) As Pageable(Of BinaryData)

パラメーター

provider

String

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

name

String

更新名。

filter

String

isDeployable プロパティで更新プログラムをフィルター処理する場合は省略可能です。

context

RequestContext

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

戻り値

Pageable<BinaryData>

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

例外

ArgumentNullException

provider または name が null です。

ArgumentException

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

RequestFailedException

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

例

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

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

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

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

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

foreach (var data in client.GetVersions("<provider>", "<name>", "<filter>"))
{
    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)
              }
            }