Devices - Get

  • Riferimento
Servizio:
IoT Central
Versione API:
2022-07-31

Ottenere un dispositivo in base all'ID
Ottenere informazioni dettagliate su un dispositivo esistente in base all'ID dispositivo.

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
baseDomain
 path True

string

Dominio di base per tutte le richieste di servizio di Azure IoT Central.
deviceId
 path True

string

ID univoco del dispositivo.
subdomain
 path True

string

Sottodominio dell'applicazione.
api-version
 query True

string

Versione dell'API chiamata.

Risposte

Nome Tipo Descrizione
200 OK

Device

Operazione riuscita
Other Status Codes

Error

Risposta di errore ricevuta dal servizio IoT Central.

Intestazioni

x-ms-error-code: string

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome Descrizione
user_impersonation rappresentare l'account utente

Esempio

Get device by ID

Esempio di richiesta

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

Risposta di esempio

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

Definizioni

Nome Descrizione
Device

Definizione del dispositivo.
Error

Definizione dell'errore di risposta.
ErrorDetails

Informazioni dettagliate sull'errore.

Device

Definizione del dispositivo.

Nome Tipo Descrizione
displayName

string

Nome visualizzato del dispositivo.
enabled

boolean

Indica se la connessione del dispositivo a IoT Central è stata abilitata.
etag

string

ETag usato per evitare conflitti negli aggiornamenti dei dispositivi.
id

string

ID univoco del dispositivo.
organizations

string[]

Elenco di ID organizzazione di cui fa parte il dispositivo, attualmente è supportata una sola organizzazione, più organizzazioni saranno presto supportate.
provisioned

boolean

Indica se le risorse sono state allocate per il dispositivo.
simulated

boolean

Indica se il dispositivo è simulato.
template

string

Definizione del modello di dispositivo per il dispositivo.

Error

Definizione dell'errore di risposta.

Nome Tipo Descrizione
error

ErrorDetails

Dettagli dell'errore per la richiesta corrente.

ErrorDetails

Informazioni dettagliate sull'errore.

Nome Tipo Descrizione
code

string

Codice di errore.
message

string

Dettagli del messaggio di errore.
requestId

string

ID correlazione per la richiesta corrente.
time

string

Ora in cui la richiesta di errore non è riuscita.