Devices - Get

Szolgáltatás:

IoT Central

API-verzió:

2022-07-31

Eszköz lekérése azonosító alapján
Meglévő eszköz adatainak lekérése eszközazonosító alapján.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
baseDomain	path	True	string	Az összes Azure IoT Central-szolgáltatáskérés alaptartománya.
deviceId	path	True	string	Az eszköz egyedi azonosítója.
subdomain	path	True	string	Az alkalmazás altartománya.
api-version	query	True	string	A meghívott API verziója.

Válaszok

Name	Típus	Description
200 OK	Device	Siker
Other Status Codes	Error	Hibaválasz érkezett az IoT Central szolgáltatástól. Fejlécek x-ms-error-code: string

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	felhasználói fiók megszemélyesítése

Példák

Get device by ID

Mintakérelem

HTTP

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

Mintaválasz

Állapotkód:

200

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

Definíciók

Name	Description
Device	Az eszközdefiníció.
Error	A válaszhiba definíciója.
ErrorDetails	A hiba részletes információi.

Device

Az eszközdefiníció.

Name	Típus	Description
displayName	string	Az eszköz megjelenített neve.
enabled	boolean	Engedélyezve van-e az IoT Centralhoz való eszközkapcsolat.
etag	string	Az eszközfrissítések ütközésének megelőzésére szolgáló ETag.
id	string	Az eszköz egyedi azonosítója.
organizations	string[]	Azon szervezeti azonosítók listája, amelyeknek az eszköz része, jelenleg csak egy szervezet támogatott, és hamarosan több szervezet is támogatott lesz.
provisioned	boolean	Az, hogy az erőforrások ki vannak-e foglalva az eszközhöz.
simulated	boolean	Hogy az eszköz szimulálva van-e.
template	string	Az eszköz eszközsablon-definíciója.

Error

A válaszhiba definíciója.

Name	Típus	Description
error	ErrorDetails	Az aktuális kérelem hibaadatai.

ErrorDetails

A hiba részletes információi.

Name	Típus	Description
code	string	Hibakód.
message	string	Hibaüzenet részletei.
requestId	string	Az aktuális kérés korrelációs azonosítója.
time	string	A hibakérés sikertelen volt.