Dela via

Devices - Get

Tjänst:
IoT Central
API-version:
2022-07-31

Hämta en enhet kopplad till ett ID
Få information om en befintlig enhet efter enhets-ID.

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

URI-parametrar

Name I Obligatorisk Typ Description
baseDomain
 path True

string

Basdomänen för alla Azure IoT Central-tjänstbegäranden.
deviceId
 path True

string

Enhetens unika ID.
subdomain
 path True

string

Programmets underdomän.
api-version
 query True

string

Den version av API:et som anropas.

Svar

Name Typ Description
200 OK

Device

Framgång
Other Status Codes

Error

Ett felsvar som togs emot från IoT Central-tjänsten.

Sidhuvuden

x-ms-error-code: string

Säkerhet

azure_auth

Azure Active Directory OAuth2-flöde

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name Description
user_impersonation personifiera ditt användarkonto

Exempel

Get device by ID

Exempelbegäran

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

Exempelsvar

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

Definitioner

Name Description
Device

Enhetsdefinitionen.
Error

Svarsfeldefinitionen.
ErrorDetails

Information om felet.

Device

Objekt

Enhetsdefinitionen.

Name Typ Description
displayName

string

Enhetens visningsnamn.
enabled

boolean

Om enhetsanslutningen till IoT Central har aktiverats.
etag

string

ETag används för att förhindra konflikter i enhetsuppdateringar.
id

string

Enhetens unika ID.
organizations

string[]

Lista över organisations-ID:n som enheten ingår i, endast en organisation stöds i dag, flera organisationer kommer snart att stödjas.
provisioned

boolean

Om resurser har allokerats för enheten.
simulated

boolean

Om enheten simuleras.
template

string

Enhetsmalldefinitionen för enheten.

Error

Objekt

Svarsfeldefinitionen.

Name Typ Description
error

ErrorDetails

Felinformation för aktuell begäran.

ErrorDetails

Objekt

Information om felet.

Name Typ Description
code

string

Felkod.
message

string

Information om felmeddelande.
requestId

string

Korrelations-ID för aktuell begäran.
time

string (date-time-rfc1123)

Den tid då felbegäran misslyckades.