Język

DeviceManagementClient.GetLogCollection(String, RequestContext) Method

Definition

Namespace:
Azure.IoT.DeviceUpdate
Assembly:
Azure.IoT.DeviceUpdate.dll
Package:
Azure.IoT.DeviceUpdate v1.1.0
Source:
DeviceManagementClient.cs

[Protocol Method] Get the device diagnostics log collection

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. 
public virtual Azure.Response GetLogCollection(string logCollectionId, Azure.RequestContext context = default);
abstract member GetLogCollection : string * Azure.RequestContext -> Azure.Response
override this.GetLogCollection : string * Azure.RequestContext -> Azure.Response
Public Overridable Function GetLogCollection (logCollectionId As String, Optional context As RequestContext = Nothing) As Response

Parameters

logCollectionId
String

Log collection identifier.

context
RequestContext

The request options, which can override default behaviors of the client pipeline on a per-call basis.

Returns

Response

The response returned from the service.

Exceptions

ArgumentNullException

logCollectionId is null.

ArgumentException

logCollectionId is an empty string, and was expected to be non-empty.

RequestFailedException

Service returned a non-success status code.

Examples

This sample shows how to call GetLogCollection with required parameters and parse the result.

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

Response response = client.GetLogCollection("<logCollectionId>");

JsonElement result = JsonDocument.Parse(response.ContentStream).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());

Remarks

Below is the JSON schema for the response payload.

Response Body:

Schema for LogCollection: 

{
              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.
            }

Applies to