Devices - Get Identity
Ruft ein Gerät aus der Identitätsregistrierung des IoT Hub ab.
GET https://fully-qualified-iothubname.azure-devices.net/devices/{id}?api-version=2021-04-12URI-Parameter
| Name | In | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
id
|
path | True |
string |
Der eindeutige Bezeichner des Geräts. |
|
api-version
|
query | True |
string |
Version der Api. |
Antworten
| Name | Typ | Beschreibung |
|---|---|---|
| 200 OK |
OK. |
Definitionen
| Name | Beschreibung |
|---|---|
|
Authentication |
|
| Device | |
|
Device |
Die status der auf dem Gerät aktivierten Funktionen. |
|
Symmetric |
|
| X509Thumbprint |
AuthenticationMechanism
| Name | Typ | Beschreibung |
|---|---|---|
| symmetricKey |
Der primäre und sekundäre Schlüssel, der für die SAS-basierte Authentifizierung verwendet wird. |
|
| type |
enum:
|
Der Typ der Authentifizierung, die zum Herstellen einer Verbindung mit dem Dienst verwendet wird. |
| x509Thumbprint |
Die primären und sekundären x509-Fingerabdrucke, die für die x509-basierte Authentifizierung verwendet werden. |
Device
| Name | Typ | Beschreibung |
|---|---|---|
| authentication |
Der vom Gerät verwendete Authentifizierungsmechanismus. |
|
| capabilities |
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 der Cloud-zu-Gerät-Nachrichten, die derzeit in der Warteschlange an das Gerät gesendet werden sollen. |
| connectionState |
enum:
|
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 ein schwaches ETag für die Geräteidentität gemäß RFC7232 darstellt. |
| generationId |
string |
Die IoT Hub generierte Zeichenfolge mit einer Länge von bis zu 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 das letzte Mal, zu dem das Gerät eine Verbindung hergestellt, 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:
|
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, zu dem das status Feld zuletzt aktualisiert wurde. |
DeviceCapabilities
Die status der auf dem Gerät aktivierten Funktionen.
| Name | Typ | Beschreibung |
|---|---|---|
| iotEdge |
boolean |
Die Eigenschaft, die bestimmt, ob es sich bei dem Gerät um ein Edgegerät handelt 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 |
Der primäre Fingerabdruck des X509-Clientzertifikats. |
| secondaryThumbprint |
string |
Der sekundäre Fingerabdruck des X509-Clientzertifikats. |