DeviceManagementClient.GetLogCollectionDetailedStatusAsync Método

Definición

Espacio de nombres:

Azure.IoT.DeviceUpdate

Ensamblado:

Azure.IoT.DeviceUpdate.dll

Paquete:

Azure.IoT.DeviceUpdate v1.0.0

Source:

DeviceManagementClient.cs

Obtiene la recopilación de registros con el estado detallado.

public virtual System.Threading.Tasks.Task<Azure.Response> GetLogCollectionDetailedStatusAsync(string logCollectionId, Azure.RequestContext context = default);

abstract member GetLogCollectionDetailedStatusAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.GetLogCollectionDetailedStatusAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>

Public Overridable Function GetLogCollectionDetailedStatusAsync (logCollectionId As String, Optional context As RequestContext = Nothing) As Task(Of Response)

Parámetros

logCollectionId

String

Identificador de recopilación de registros.

context

RequestContext

Contexto de solicitud, que puede invalidar los comportamientos predeterminados de la canalización de cliente por llamada.

Devoluciones

Task<Response>

Respuesta devuelta desde el servicio. Los detalles del esquema del cuerpo de la respuesta se encuentran en la sección Comentarios a continuación.

Excepciones

ArgumentNullException

logCollectionId es null.

ArgumentException

logCollectionId es una cadena vacía y se espera que no esté vacía.

RequestFailedException

El servicio devolvió un código de estado no correcto.

Ejemplos

En este ejemplo se muestra cómo llamar a GetLogCollectionDetailedStatusAsync con los parámetros necesarios y analizar el resultado.

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

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

JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("operationId").ToString());
Console.WriteLine(result.GetProperty("createdDateTime").ToString());
Console.WriteLine(result.GetProperty("lastActionDateTime").ToString());
Console.WriteLine(result.GetProperty("status").ToString());
Console.WriteLine(result.GetProperty("deviceStatus")[0].GetProperty("deviceId").ToString());
Console.WriteLine(result.GetProperty("deviceStatus")[0].GetProperty("moduleId").ToString());
Console.WriteLine(result.GetProperty("deviceStatus")[0].GetProperty("status").ToString());
Console.WriteLine(result.GetProperty("deviceStatus")[0].GetProperty("resultCode").ToString());
Console.WriteLine(result.GetProperty("deviceStatus")[0].GetProperty("extendedResultCode").ToString());
Console.WriteLine(result.GetProperty("deviceStatus")[0].GetProperty("logLocation").ToString());
Console.WriteLine(result.GetProperty("description").ToString());

Comentarios

A continuación se muestra el esquema JSON para la carga de respuesta.

Cuerpo de la respuesta:

Esquema para LogCollectionOperationDetailedStatus:

{
              operationId: string, # Optional. The device diagnostics operation id.
              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.
              deviceStatus: [
                {
                  deviceId: string, # Required. Device id
                  moduleId: string, # Optional. Module id.
                  status: "NotStarted" | "Running" | "Succeeded" | "Failed", # Required. Log upload status
                  resultCode: string, # Optional. Log upload result code
                  extendedResultCode: string, # Optional. Log upload extended result code
                  logLocation: string, # Optional. Log upload location
                }
              ], # Optional. Status of the devices in the operation
              description: string, # Optional. Device diagnostics operation description.
            }