DeviceManagementClient.GetLogCollectionsAsync(RequestContext) メソッド

  • リファレンス

定義

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

すべてのデバイス診断ログ コレクションを取得します。

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

パラメーター

context
RequestContext

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

戻り値

AsyncPageable<BinaryData>

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

例外

RequestFailedException

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

例

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

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.GetLogCollectionsAsync())
{
    JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement;
    Console.WriteLine(result.GetProperty("operationId").ToString());
    Console.WriteLine(result.GetProperty("deviceList")[0].GetProperty("deviceId").ToString());
    Console.WriteLine(result.GetProperty("deviceList")[0].GetProperty("moduleId").ToString());
    Console.WriteLine(result.GetProperty("description").ToString());
    Console.WriteLine(result.GetProperty("createdDateTime").ToString());
    Console.WriteLine(result.GetProperty("lastActionDateTime").ToString());
    Console.WriteLine(result.GetProperty("status").ToString());
}

注釈

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

応答本文:

の LogCollectionListValueスキーマ:

{
              operationId: string, # Optional. The log collection id.
              deviceList: [
                {
                  deviceId: string, # Required. Device Id
                  moduleId: string, # Optional. Module Id
                }
              ], # Required. Array of Device Update agent ids
              description: string, # Optional. Description of the diagnostics operation.
              createdDateTime: string, # Optional. The timestamp when the operation was created.
              lastActionDateTime: string, # Optional. A timestamp for when the current state was entered.
              status: "NotStarted" | "Running" | "Succeeded" | "Failed", # Optional. Operation status.
            }

適用対象