Compartilhar via

Query - Get Twins

  • Referência
Serviço:
IoT Hub
Versão da API:
2021-04-12

Consulte um Hub IoT para recuperar informações sobre dispositivos gêmeos usando uma linguagem semelhante a SQL. Consulte https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language para obter mais informações. Há suporte para paginação. Isso retorna informações apenas sobre dispositivos gêmeos.

POST https://fully-qualified-iothubname.azure-devices.net/devices/query?api-version=2021-04-12

Parâmetros de URI

Nome Em Obrigatório Tipo Description
api-version
 query True

string

Versão da API.

Cabeçalho da solicitação

Nome Obrigatório Tipo Description
x-ms-continuation

string

O token de continuação usado para obter a próxima página de resultados.
x-ms-max-item-count

string

O número máximo de itens retornados por página. O serviço poderá usar um valor diferente se o valor especificado não for aceitável.

Corpo da solicitação

Nome Tipo Description
query

string

A cadeia de caracteres de consulta.

Respostas

Nome Tipo Description
200 OK

Twin[]

OK.

Cabeçalhos

  • x-ms-item-type: string
  • x-ms-continuation: string

Definições

Nome Description
DeviceCapabilities

O status de recursos habilitados no dispositivo.
QuerySpecification

A solicitação de consulta Json.
Twin

As informações de estado de um dispositivo ou módulo. Isso é criado e excluído implicitamente quando a identidade do dispositivo/módulo correspondente é criada ou excluída no Hub IoT.
TwinProperties

As propriedades desejadas e relatadas do gêmeo. A profundidade máxima do objeto é 10.
X509Thumbprint

DeviceCapabilities

O status de recursos habilitados no dispositivo.

Nome Tipo Description
iotEdge

boolean

A propriedade que determina se o dispositivo é um dispositivo de borda ou não.

QuerySpecification

A solicitação de consulta Json.

Nome Tipo Description
query

string

A cadeia de caracteres de consulta.

Twin

As informações de estado de um dispositivo ou módulo. Isso é criado e excluído implicitamente quando a identidade do dispositivo/módulo correspondente é criada ou excluída no Hub IoT.

Nome Tipo Description
authenticationType enum:
  • certificateAuthority
  • none
  • sas
  • selfSigned

O tipo de autenticação usado pelo dispositivo.
capabilities

DeviceCapabilities

O status de recursos habilitados no dispositivo.
cloudToDeviceMessageCount

integer

O número de mensagens da nuvem para o dispositivo enviadas.
connectionState enum:
  • Connected
  • Disconnected

O estado de conexão do dispositivo.
deviceEtag

string

A cadeia de caracteres que representa uma ETag para o dispositivo, de acordo com RFC7232.
deviceId

string

O identificador exclusivo do dispositivo no registro de identidade do Hub IoT. É uma cadeia de caracteres que diferencia maiúsculas de minúsculas (até 128 caracteres de comprimento) de caracteres alfanuméricos ASCII de 7 bits, e os seguintes caracteres especiais {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', ',', '=', '@', ';', '$', '''}.
deviceScope

string

O escopo do dispositivo.
etag

string

A cadeia de caracteres que representa uma ETag para o dispositivo gêmeo, de acordo com RFC7232.
lastActivityTime

string

A data e a hora em que o dispositivo se conectou pela última vez ou recebeu ou enviou uma mensagem. A data e a hora são especificadas em ISO8601 formato datetime em UTC, por exemplo, 2015-01-28T16:24:48.789Z. Esse valor não será atualizado se o dispositivo usar o protocolo HTTP/1 para executar operações de mensagens.
moduleId

string

O identificador exclusivo do módulo no registro de identidade do Hub IoT. É uma cadeia de caracteres que diferencia maiúsculas de minúsculas (até 128 caracteres de comprimento) de caracteres alfanuméricos ASCII de 7 bits, e os seguintes caracteres especiais {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', ',', '=', '@', ';', '$', '''}.
parentScopes

string[]

Os escopos dos dispositivos de borda de nível superior, se aplicável. Disponível somente para dispositivos de borda.
properties

TwinProperties

As propriedades desejadas e relatadas do gêmeo.
status enum:
  • disabled
  • enabled

O status habilitado do dispositivo. Se estiver desabilitado, o dispositivo não poderá se conectar ao serviço.
statusReason

string

O motivo da status atual do dispositivo, se houver.
statusUpdateTime

string

A data e a hora em que o status do dispositivo foi atualizado pela última vez.
tags

object

A coleção de pares chave-valor lida e gravada pelo back-end da solução. Eles não são visíveis para aplicativos de dispositivo. As chaves são codificadas em UTF-8, diferenciam maiúsculas de minúsculas e até 1 KB de comprimento. Os caracteres permitidos excluem caracteres de controle UNICODE (segmentos C0 e C1), '.', '$' e espaço. Os valores são objetos JSON, com até 4 KB de comprimento.
version

integer

A versão do dispositivo gêmeo, incluindo marcas e propriedades desejadas
x509Thumbprint

X509Thumbprint

A impressão digital X509 do dispositivo.

TwinProperties

As propriedades desejadas e relatadas do gêmeo. A profundidade máxima do objeto é 10.

Nome Tipo Description
desired

object

A coleção de pares chave-valor de propriedade desejados. As chaves são codificadas em UTF-8, diferenciam maiúsculas de minúsculas e até 1 KB de comprimento. Os caracteres permitidos excluem caracteres de controle UNICODE (segmentos C0 e C1), '.', '$' e espaço. Os valores de propriedade desejados são objetos JSON, com até 4 KB de comprimento.
reported

object

A coleção de pares chave-valor de propriedade relatados. As chaves são codificadas em UTF-8, diferenciam maiúsculas de minúsculas e até 1 KB de comprimento. Os caracteres permitidos excluem caracteres de controle UNICODE (segmentos C0 e C1), '.', '$' e espaço. Os valores de propriedade relatados são objetos JSON, com até 4 KB de comprimento.

X509Thumbprint

Nome Tipo Description
primaryThumbprint

string

A impressão digital primária do certificado do cliente X509.
secondaryThumbprint

string

A impressão digital secundária do certificado do cliente X509.