Devices - Get Devices

  • Riferimento
Servizio:
IoT Hub
Versione API:
2021-04-12

Ottiene le identità di più dispositivi dal Registro di sistema di identità di hub IoT. Non consigliato. Usare l'API query hub IoT per recuperare le informazioni sull'identità del dispositivo gemello e del dispositivo. Per altre informazioni, vedere https://docs.microsoft.com/en-us/rest/api/iothub/service/queryiothub e https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-query-language.

GET https://fully-qualified-iothubname.azure-devices.net/devices?api-version=2021-04-12
Con parametri facoltativi: 
GET https://fully-qualified-iothubname.azure-devices.net/devices?top={top}&api-version=2021-04-12

Parametri dell'URI

Nome In Necessario Tipo Descrizione
api-version
 query True

string

Versione dell'API.
top
 query

integer

int32

Numero massimo di identità del dispositivo restituite dalla query. Qualsiasi valore all'esterno dell'intervallo di 1-1000 viene considerato 1000.

Risposte

Nome Tipo Descrizione
200 OK

Device[]

OK.

Definizioni

Nome Descrizione
AuthenticationMechanism
Device
DeviceCapabilities

Stato delle funzionalità abilitate nel dispositivo.
SymmetricKey
X509Thumbprint

AuthenticationMechanism

Nome Tipo Descrizione
symmetricKey

SymmetricKey

Chiavi primarie e secondarie usate per l'autenticazione basata su firma di accesso condiviso.
type enum:
  • certificateAuthority
  • none
  • sas
  • selfSigned

Tipo di autenticazione utilizzata per connettersi al servizio.
x509Thumbprint

X509Thumbprint

Identificazione personale primaria e secondaria x509 usata per l'autenticazione basata su x509.

Device

Nome Tipo Descrizione
authentication

AuthenticationMechanism

Meccanismo di autenticazione usato dal dispositivo.
capabilities

DeviceCapabilities

Set di funzionalità del dispositivo. Ad esempio, se questo dispositivo è un dispositivo perimetrale o meno.
cloudToDeviceMessageCount

integer

Numero di messaggi da cloud a dispositivo attualmente in coda da inviare al dispositivo.
connectionState enum:
  • Connected
  • Disconnected

Stato del dispositivo.
connectionStateUpdatedTime

string

Data e ora dell'ultimo aggiornamento dello stato della connessione.
deviceId

string

Identificatore univoco del dispositivo.
deviceScope

string

Ambito del dispositivo. Generato automaticamente e non modificabile per i dispositivi perimetrali e modificabile nei dispositivi foglia per creare una relazione figlio/padre.
etag

string

Stringa che rappresenta un ETag debole per l'identità del dispositivo, come per RFC7232.
generationId

string

Stringa con distinzione tra maiuscole e minuscole hub IoT fino a 128 caratteri. Tale valore viene usato per distinguere i dispositivi con la stessa proprietà deviceId in caso di eliminazione e nuova creazione.
lastActivityTime

string

Data e ultima volta che il dispositivo è stato connesso, ricevuto o inviato un messaggio.
parentScopes

string[]

Se applicabile, gli ambiti dei dispositivi perimetrali di livello superiore. Disponibile solo per i dispositivi perimetrali.
status enum:
  • disabled
  • enabled

Stato del dispositivo. Se lo stato è disabilitato, un dispositivo non può connettersi al servizio.
statusReason

string

Stringa lunga 128 caratteri che archivia il motivo dello stato dell'identità del dispositivo. Sono consentiti tutti i caratteri UTF-8.
statusUpdatedTime

string

Data e ora dell'ultimo aggiornamento del campo di stato.

DeviceCapabilities

Stato delle funzionalità abilitate nel dispositivo.

Nome Tipo Descrizione
iotEdge

boolean

Proprietà che determina se il dispositivo è un dispositivo perimetrale o meno.

SymmetricKey

Nome Tipo Descrizione
primaryKey

string

Chiave primaria con codifica base64 del dispositivo.
secondaryKey

string

Chiave secondaria con codifica base64 del dispositivo.

X509Thumbprint

Nome Tipo Descrizione
primaryThumbprint

string

Identificazione personale primaria del certificato client X509.
secondaryThumbprint

string

Identificazione personale secondaria del certificato client X509.