Freigeben über

Devices - Get Devices

  • Referenz
Dienst:
IoT Hub
API-Version:
2021-04-12

Ruft die Identitäten mehrerer Geräte aus der IoT Hub-Identitätsregistrierung ab. Nicht empfohlen. Verwenden Sie die IoT Hub-Abfrage-API zum Abrufen von Geräte-Twin- und Geräteidentitätsinformationen. Weitere Informationen finden Sie unter https://docs.microsoft.com/en-us/rest/api/iothub/service/queryiothub und 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
Mit optionalen Parametern: 
GET https://fully-qualified-iothubname.azure-devices.net/devices?top={top}&api-version=2021-04-12

URI-Parameter

Name In Erforderlich Typ Beschreibung
api-version
 query True

string

Version der API.
top
 query

integer (int32)

Die maximale Anzahl von Geräteidentitäten, die von der Abfrage zurückgegeben werden. Ein beliebiger Wert außerhalb des Bereichs von 1-1000 wird als 1000 betrachtet.

Antworten

Name Typ Beschreibung
200 OK

Device[]

OKAY.

Definitionen

Name Beschreibung
AuthenticationMechanism
Device
DeviceCapabilities

Der Status der auf dem Gerät aktivierten Funktionen.
SymmetricKey
X509Thumbprint

AuthenticationMechanism

Objekt
Name Typ Beschreibung
symmetricKey

SymmetricKey

Die primären und sekundären Schlüssel, die für die SAS-basierte Authentifizierung verwendet werden.
type enum:
  • certificateAuthority
  • none
  • sas
  • selfSigned

Der Typ der Authentifizierung, die zum Herstellen einer Verbindung mit dem Dienst verwendet wird.
x509Thumbprint

X509Thumbprint

Die primären und sekundären x509-Fingerabdrucke, die für die x509-basierte Authentifizierung verwendet werden.

Device

Objekt
Name Typ Beschreibung
authentication

AuthenticationMechanism

Der vom Gerät verwendete Authentifizierungsmechanismus.
capabilities

DeviceCapabilities

Der Satz von Funktionen des Geräts. Wenn es sich bei diesem Gerät beispielsweise um ein Edgegerät handelt oder nicht.
cloudToDeviceMessageCount

integer (int32)

Die Anzahl der aktuell in die Warteschlange eingereihten Cloud-zu-Gerät-Nachrichten, die an das Gerät gesendet werden sollen.
connectionState enum:
  • Connected
  • Disconnected

Der Zustand des Geräts.
connectionStateUpdatedTime

string (date-time)

Datum und Uhrzeit der letzten Aktualisierung des Verbindungsstatus.
deviceId

string

Der eindeutige Bezeichner des Geräts.
deviceScope

string

Der Bereich des Geräts. Automatisch generiert und unveränderlich für Edgegeräte und modifizierbar auf Blattgeräten zum Erstellen einer untergeordneten/übergeordneten Beziehung.
etag

string

Die Zeichenfolge, die ein schwaches ETag für die Geräteidentität gemäß RFC7232 darstellt.
generationId

string

Die vom IoT Hub generierte, groß- und kleinschreibungsbezogene Zeichenfolge bis zu 128 Zeichen lang. Dieser Wert wird verwendet, um Geräte mit derselben deviceId zu unterscheiden, wenn sie gelöscht und neu erstellt wurden.
lastActivityTime

string (date-time)

Das Datum und die letzte Uhrzeit, zu der das Gerät zuletzt verbunden, empfangen oder eine Nachricht gesendet hat.
parentScopes

string[]

Die Bereiche der Edgegeräte der oberen Ebene, falls zutreffend. Nur für Edgegeräte verfügbar.
status enum:
  • disabled
  • enabled

Der Status des Geräts. Wenn der Status deaktiviert ist, kann ein Gerät keine Verbindung mit dem Dienst herstellen.
statusReason

string

Die 128 zeichen lange Zeichenfolge, die den Grund für den Geräteidentitätsstatus speichert. Alle UTF-8-Zeichen sind zulässig.
statusUpdatedTime

string (date-time)

Datum und Uhrzeit der letzten Aktualisierung des Statusfelds.

DeviceCapabilities

Objekt

Der Status der auf dem Gerät aktivierten Funktionen.

Name Typ Beschreibung
iotEdge

boolean

Die Eigenschaft, die bestimmt, ob das Gerät ein Edgegerät ist oder nicht.

SymmetricKey

Objekt
Name Typ Beschreibung
primaryKey

string

Der base64-codierte Primärschlüssel des Geräts.
secondaryKey

string

Der base64-codierte Sekundärschlüssel des Geräts.

X509Thumbprint

Objekt
Name Typ Beschreibung
primaryThumbprint

string

Der primäre Fingerabdruck des X509-Clientzertifikats.
secondaryThumbprint

string

Sekundärer Fingerabdruck des X509-Clientzertifikats.