DeviceManagementClient.GetBestUpdatesForGroupsAsync 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 las mejores actualizaciones disponibles para un grupo de dispositivos y un recuento de cuántos dispositivos necesitan cada actualización.

public virtual Azure.AsyncPageable<BinaryData> GetBestUpdatesForGroupsAsync(string groupId, Azure.RequestContext context = default);

abstract member GetBestUpdatesForGroupsAsync : string * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>
override this.GetBestUpdatesForGroupsAsync : string * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>

Public Overridable Function GetBestUpdatesForGroupsAsync (groupId As String, Optional context As RequestContext = Nothing) As AsyncPageable(Of BinaryData)

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

AsyncPageable<BinaryData>

del AsyncPageable<T> servicio que contiene una lista de BinaryData objetos. Los detalles del esquema de cuerpo de cada elemento de la colección 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 GetBestUpdatesForGroupsAsync 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);

await foreach (var data in client.GetBestUpdatesForGroupsAsync("<groupId>"))
{
    JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement;
    Console.WriteLine(result.GetProperty("groupId").ToString());
    Console.WriteLine(result.GetProperty("deviceClassId").ToString());
    Console.WriteLine(result.GetProperty("update").GetProperty("updateId").GetProperty("provider").ToString());
    Console.WriteLine(result.GetProperty("update").GetProperty("updateId").GetProperty("name").ToString());
    Console.WriteLine(result.GetProperty("update").GetProperty("updateId").GetProperty("version").ToString());
    Console.WriteLine(result.GetProperty("update").GetProperty("description").ToString());
    Console.WriteLine(result.GetProperty("update").GetProperty("friendlyName").ToString());
    Console.WriteLine(result.GetProperty("deviceCount").ToString());
}

Comentarios

A continuación se muestra el esquema JSON de un elemento de la respuesta paginable.

Cuerpo de la respuesta:

Esquema para DeviceClassSubgroupUpdatableDevicesListValue:

{
              groupId: string, # Required. The group Id
              deviceClassId: string, # Required. The device class subgroup's device class Id
              update: {
                updateId: {
                  provider: string, # Required. Update provider.
                  name: string, # Required. Update name.
                  version: string, # Required. Update version.
                }, # Required. Update identifier.
                description: string, # Optional. Update description.
                friendlyName: string, # Optional. Friendly update name.
              }, # Required. Update information.
              deviceCount: number, # Required. Total number of devices for which the update is applicable.
            }