Devices - Get Devices

Dienst:

IoT Hub

API-Version:

2021-04-12

Ruft die Identitäten mehrerer Geräte aus der IoT Hub Identitätsregistrierung ab. Nicht empfehlenswert. Verwenden Sie die IoT Hub-Abfrage-API, um Gerätezwillwillungs- und Geräteidentitätsinformationen abzurufen. 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. Jeder Wert außerhalb des Bereichs von 1 bis 1000 wird als 1000 betrachtet.

Antworten

Name	Typ	Beschreibung
200 OK	Device[]	OK.

Definitionen

Name	Beschreibung
AuthenticationMechanism
Device
DeviceCapabilities	Die status von Funktionen, die auf dem Gerät aktiviert sind.
SymmetricKey
X509Thumbprint

AuthenticationMechanism

Name	Typ	Beschreibung
symmetricKey	SymmetricKey	Der primäre und sekundäre Schlüssel, der für die SAS-basierte Authentifizierung verwendet wird.
type	enum: certificateAuthority none sas selfSigned	Der Authentifizierungstyp, der zum Herstellen einer Verbindung mit dem Dienst verwendet wird.
x509Thumbprint	X509Thumbprint	Die primären und sekundären x509-Fingerabdruck, die für die x509-basierte Authentifizierung verwendet werden.

Device

Name	Typ	Beschreibung
authentication	AuthenticationMechanism	Der vom Gerät verwendete Authentifizierungsmechanismus.
capabilities	DeviceCapabilities	Der Satz von Funktionen des Geräts. Beispielsweise, wenn es sich bei diesem Gerät um ein Edgegerät handelt oder nicht.
cloudToDeviceMessageCount	integer	Die Anzahl von Cloud-zu-Gerät-Nachrichten, die derzeit in die Warteschlange gestellt werden, um an das Gerät gesendet zu werden.
connectionState	enum: Connected Disconnected	Der Zustand des Geräts.
connectionStateUpdatedTime	string	Das Datum und die 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 änderbar in Blattgeräten, um eine untergeordnete/übergeordnete Beziehung zu erstellen.
etag	string	Die Zeichenfolge, die gemäß RFC7232 ein schwaches ETag für die Geräteidentität darstellt.
generationId	string	Die IoT Hub generierte Zeichenfolge mit einer Länge von bis zu 128 Zeichen unter 128 Zeichen. Dieser Wert dient zur Unterscheidung von Geräten mit derselben deviceId, wenn diese gelöscht und neu erstellt wurden.
lastActivityTime	string	Das Datum und die letzte Uhrzeit, zu der das Gerät zuletzt eine Nachricht hergestellt, empfangen oder 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	Die status des Geräts. Wenn die 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 die Geräteidentität status speichert. Alle UTF-8-Zeichen sind zulässig.
statusUpdatedTime	string	Das Datum und die Uhrzeit der letzten Aktualisierung des felds status.

DeviceCapabilities

Die status von Funktionen, die auf dem Gerät aktiviert sind.

Name	Typ	Beschreibung
iotEdge	boolean	Die -Eigenschaft, die bestimmt, ob das Gerät ein Edgegerät ist oder nicht.

SymmetricKey

Name	Typ	Beschreibung
primaryKey	string	Der base64-codierte Primärschlüssel des Geräts.
secondaryKey	string	Der base64-codierte sekundäre Schlüssel des Geräts.

X509Thumbprint

Name	Typ	Beschreibung
primaryThumbprint	string	Primärer Fingerabdruck des X509-Clientzertifikats.
secondaryThumbprint	string	Sekundärer Fingerabdruck des X509-Clientzertifikats.