Devices - Get

Service:

IoT Central

API Version:

2022-07-31

Een apparaat ophalen op basis van id
Meer informatie over een bestaand apparaat per apparaat-id.

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

URI-parameters

Name	In	Vereist	Type	Description
baseDomain	path	True	string	Het basisdomein voor alle Azure IoT Central-serviceaanvragen.
deviceId	path	True	string	Unieke id van het apparaat.
subdomain	path	True	string	Het subdomein van de toepassing.
api-version	query	True	string	De versie van de API die wordt aangeroepen.

Antwoorden

Name	Type	Description
200 OK	Device	Geslaagd
Other Status Codes	Error	Er is een foutbericht ontvangen van de IoT Central-service. Headers x-ms-error-code: string

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

Get device by ID

Sample Request

HTTP

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

Sample Response

Status code:

200

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

Definities

Name	Description
Device	De apparaatdefinitie.
Error	De antwoordfoutdefinitie.
ErrorDetails	De gedetailleerde informatie van de fout.

Device

De apparaatdefinitie.

Name	Type	Description
displayName	string	Weergavenaam van het apparaat.
enabled	boolean	Of de apparaatverbinding met IoT Central is ingeschakeld.
etag	string	ETag die wordt gebruikt om conflict in apparaatupdates te voorkomen.
id	string	Unieke id van het apparaat.
organizations	string[]	Lijst met organisatie-id's waarvan het apparaat deel uitmaakt. Er wordt momenteel slechts één organisatie ondersteund. Meerdere organisaties worden binnenkort ondersteund.
provisioned	boolean	Of er resources zijn toegewezen voor het apparaat.
simulated	boolean	Of het apparaat wordt gesimuleerd.
template	string	De definitie van de apparaatsjabloon voor het apparaat.

Error

De antwoordfoutdefinitie.

Name	Type	Description
error	ErrorDetails	Foutdetails voor de huidige aanvraag.

ErrorDetails

De gedetailleerde informatie van de fout.

Name	Type	Description
code	string	Foutcode.
message	string	Details van foutbericht.
requestId	string	Correlatie-id voor huidige aanvraag.
time	string	Het tijdstip waarop de foutaanvraag is mislukt.