Devices - Get

Dienst:

IoT Central

API-Version:

2022-07-31

Abrufen eines Geräts nach ID
Rufen Sie Details zu einem vorhandenen Gerät nach Geräte-ID ab.

GET https://{subdomain}.{baseDomain}/api/devices/{deviceId}?api-version=2022-07-31

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
baseDomain	path	True	string	Die Basisdomäne für alle Azure IoT Central-Dienstanforderungen.
deviceId	path	True	string	Eindeutige ID des Geräts.
subdomain	path	True	string	Die Anwendungsunterdomäne.
api-version	query	True	string	Die Version der aufgerufenen API.

Antworten

Name	Typ	Beschreibung
200 OK	Device	Erfolg
Other Status Codes	Error	Eine Vom IoT Central Service empfangene Fehlerantwort. Header x-ms-error-code: string

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

Get device by ID

Beispielanforderung

HTTP

GET https://appsubdomain.azureiotcentral.com/api/devices/CheckoutThermostat?api-version=2022-07-31

Beispiel für eine Antwort

Statuscode:

200

{
  "id": "CheckoutThermostat",
  "etag": "eyJoZWFkZXIiOiJcIjAyMDA4YzMyLTAwMDAtMGQwMC0wMDAwLTVkOTY4YjdhMDAwMFwiIn0",
  "displayName": "CheckoutThermostat",
  "template": "dtmi:contoso:testDeviceTemplate;1",
  "simulated": true,
  "provisioned": true,
  "enabled": true,
  "organizations": [
    "seattle"
  ]
}

Definitionen

Name	Beschreibung
Device	Die Gerätedefinition.
Error	Die Antwortfehlerdefinition.
ErrorDetails	Die Detailinformationen des Fehlers.

Device

Die Gerätedefinition.

Name	Typ	Beschreibung
displayName	string	Anzeigename des Geräts.
enabled	boolean	Gibt an, ob die Geräteverbindung mit IoT Central aktiviert wurde.
etag	string	ETag, der verwendet wird, um Konflikte bei Geräteupdates zu verhindern.
id	string	Eindeutige ID des Geräts.
organizations	string[]	Liste der organization IDs, zu denen das Gerät gehört, nur eine organization wird heute unterstützt, mehrere Organisationen werden in Kürze unterstützt.
provisioned	boolean	Gibt an, ob Ressourcen für das Gerät zugewiesen wurden.
simulated	boolean	Gibt an, ob das Gerät simuliert wird.
template	string	Die Gerätevorlagendefinition für das Gerät.

Error

Die Antwortfehlerdefinition.

Name	Typ	Beschreibung
error	ErrorDetails	Fehlerdetails für die aktuelle Anforderung.

ErrorDetails

Die Detailinformationen des Fehlers.

Name	Typ	Beschreibung
code	string	Fehlercode
message	string	Fehlermeldungsdetails.
requestId	string	Korrelations-ID für die aktuelle Anforderung.
time	string	Der Zeitpunkt, zu dem die Fehleranforderung fehlgeschlagen ist.