DeviceManagementClient.GetHealthOfDevices(String, RequestContext) Método
Definición
Importante
Parte de la información hace referencia a la versión preliminar del producto, que puede haberse modificado sustancialmente antes de lanzar la versión definitiva. Microsoft no otorga ninguna garantía, explícita o implícita, con respecto a la información proporcionada aquí.
Obtiene la lista de estado del dispositivo.
public virtual Azure.Pageable<BinaryData> GetHealthOfDevices(string filter, Azure.RequestContext context = default);
abstract member GetHealthOfDevices : string * Azure.RequestContext -> Azure.Pageable<BinaryData>
override this.GetHealthOfDevices : string * Azure.RequestContext -> Azure.Pageable<BinaryData>
Public Overridable Function GetHealthOfDevices (filter As String, Optional context As RequestContext = Nothing) As Pageable(Of BinaryData)
Parámetros
- filter
- String
Restringe el conjunto de dispositivos para los que se devuelve el estado del dispositivo. Puede filtrar el estado, el identificador del dispositivo y el identificador del módulo.
- context
- RequestContext
Contexto de solicitud, que puede invalidar los comportamientos predeterminados de la canalización de cliente por llamada.
Devoluciones
del Pageable<T> servicio que contiene una lista de BinaryData objetos. Los detalles del esquema del cuerpo de cada elemento de la colección se encuentran en la sección Comentarios a continuación.
Excepciones
filter
es null.
El servicio devolvió un código de estado no correcto.
Ejemplos
En este ejemplo se muestra cómo llamar a GetHealthOfDevices 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);
foreach (var data in client.GetHealthOfDevices("<filter>"))
{
JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("deviceId").ToString());
Console.WriteLine(result.GetProperty("moduleId").ToString());
Console.WriteLine(result.GetProperty("state").ToString());
Console.WriteLine(result.GetProperty("digitalTwinModelId").ToString());
Console.WriteLine(result.GetProperty("healthChecks")[0].GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("healthChecks")[0].GetProperty("result").ToString());
}
Comentarios
A continuación se muestra el esquema JSON de un elemento de la respuesta paginable.
Cuerpo de la respuesta:
Esquema para DeviceHealthListValue
:
{
deviceId: string, # Required. Device id
moduleId: string, # Optional. Module id
state: "healthy" | "unhealthy", # Required. Aggregate device health state
digitalTwinModelId: string, # Optional. Digital twin model Id
healthChecks: [
{
name: string, # Optional. Health check name
result: "success" | "userError", # Optional. Health check result
}
], # Required. Array of health checks and their results
}
Se aplica a
Azure SDK for .NET