DeviceManagementClient.GetUpdateComplianceForGroup 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

Obtenga información de cumplimiento de actualizaciones del grupo de dispositivos, como el número de dispositivos en su actualización más reciente, cuántos necesitan nuevas actualizaciones y cuántos están en curso al recibir una nueva actualización.

public virtual Azure.Response GetUpdateComplianceForGroup(string groupId, Azure.RequestContext context = default);

abstract member GetUpdateComplianceForGroup : string * Azure.RequestContext -> Azure.Response
override this.GetUpdateComplianceForGroup : string * Azure.RequestContext -> Azure.Response

Public Overridable Function GetUpdateComplianceForGroup (groupId As String, Optional context As RequestContext = Nothing) As Response

Parámetros

groupId

String

Identificador de grupo.

context

RequestContext

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

Devoluciones

Response

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

Excepciones

ArgumentNullException

groupId es null.

ArgumentException

groupId es una cadena vacía y se esperaba que no estuviera vacía.

RequestFailedException

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

Ejemplos

En este ejemplo se muestra cómo llamar a GetUpdateComplianceForGroup 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 = client.GetUpdateComplianceForGroup("<groupId>");

JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("totalDeviceCount").ToString());
Console.WriteLine(result.GetProperty("onLatestUpdateDeviceCount").ToString());
Console.WriteLine(result.GetProperty("newUpdatesAvailableDeviceCount").ToString());
Console.WriteLine(result.GetProperty("updatesInProgressDeviceCount").ToString());

Comentarios

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

Cuerpo de la respuesta:

Esquema para UpdateCompliance:

{
              totalDeviceCount: number, # Required. Total number of devices.
              onLatestUpdateDeviceCount: number, # Required. Number of devices on the latest update.
              newUpdatesAvailableDeviceCount: number, # Required. Number of devices with a newer update available.
              updatesInProgressDeviceCount: number, # Required. Number of devices with update in-progress.
            }