DeviceManagementClient.GetDeviceClassSubgroupsForGroups Método

Referência

Definição

Namespace:: Azure.IoT.DeviceUpdate

Assembly:: Azure.IoT.DeviceUpdate.dll

Pacote:: Azure.IoT.DeviceUpdate v1.0.0

Origem:: DeviceManagementClient.cs

Importante

Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.

Obtenha os subgrupos de classe de dispositivo para o grupo. Um subgrupo de classe de dispositivo é o conjunto de dispositivos dentro do grupo que compartilham a mesma classe de dispositivo. Todos os dispositivos na mesma classe de dispositivo são compatíveis com as mesmas atualizações.

public virtual Azure.Pageable<BinaryData> GetDeviceClassSubgroupsForGroups (string groupId, string filter = default, Azure.RequestContext context = default);

abstract member GetDeviceClassSubgroupsForGroups : string * string * Azure.RequestContext -> Azure.Pageable<BinaryData>
override this.GetDeviceClassSubgroupsForGroups : string * string * Azure.RequestContext -> Azure.Pageable<BinaryData>

Public Overridable Function GetDeviceClassSubgroupsForGroups (groupId As String, Optional filter As String = Nothing, Optional context As RequestContext = Nothing) As Pageable(Of BinaryData)

Parâmetros

groupId: String

Identificador de grupo.

filter: String

Restringe o conjunto de subgrupos de classe de dispositivo retornados. Você pode filtrar as propriedades de compatibilidade por nome e valor. (ou seja, filter=compatProperties/propertyName1 eq 'value1' e compatProperties/propertyName2 eq 'value2').

context: RequestContext

O contexto de solicitação, que pode substituir os comportamentos padrão do pipeline do cliente por chamada.

Retornos

Pageable<BinaryData>

O Pageable<T> do serviço que contém uma lista de BinaryData objetos. Os detalhes do esquema do corpo de cada item na coleção estão na seção Comentários abaixo.

Exceções

ArgumentNullException

groupId é nulo.

ArgumentException

groupId é uma cadeia de caracteres vazia e era esperado que não estivesse vazio.

RequestFailedException

O serviço retornou um código de status sem êxito.

Exemplos

Este exemplo mostra como chamar GetDeviceClassSubgroupsForGroups com os parâmetros necessários e analisar o 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.GetDeviceClassSubgroupsForGroups("<groupId>"))
{
    JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement;
    Console.WriteLine(result.GetProperty("deviceClassId").ToString());
    Console.WriteLine(result.GetProperty("groupId").ToString());
    Console.WriteLine(result.GetProperty("createdDateTime").ToString());
}

Este exemplo mostra como chamar GetDeviceClassSubgroupsForGroups com todos os parâmetros e como analisar o 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.GetDeviceClassSubgroupsForGroups("<groupId>", "<filter>"))
{
    JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement;
    Console.WriteLine(result.GetProperty("deviceClassId").ToString());
    Console.WriteLine(result.GetProperty("groupId").ToString());
    Console.WriteLine(result.GetProperty("createdDateTime").ToString());
    Console.WriteLine(result.GetProperty("deviceCount").ToString());
    Console.WriteLine(result.GetProperty("deploymentId").ToString());
}

Comentários

Abaixo está o esquema JSON para um item na resposta paginável.

Corpo da resposta:

Esquema para DeviceClassSubgroupsListValue:

{
              deviceClassId: string, # Required. Device class subgroup identity. This is generated from the model Id and the compat properties reported by the device update agent in the Device Update PnP interface in IoT Hub. It is a hex-encoded SHA1 hash.
              groupId: string, # Required. Group identity.
              createdDateTime: string, # Required. Date and time when the device class subgroup was created.
              deviceCount: number, # Optional. The number of devices in the device class subgroup.
              deploymentId: string, # Optional. The active deployment Id for the device class subgroup.
            }

Aplica-se a

Compartilhar via