Partager via

Devices - Get

  • Référence
Service:
IoT Central
Version d'API:
2022-07-31

Obtenir un appareil via son ID
Obtenez des détails sur un appareil existant par ID d’appareil.

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

Paramètres URI

Nom Dans Obligatoire Type Description
baseDomain
 path True

string

Domaine de base pour toutes les demandes de service Azure IoT Central.
deviceId
 path True

string

ID unique de l’appareil.
subdomain
 path True

string

Sous-domaine de l’application.
api-version
 query True

string

Version de l’API appelée.

Réponses

Nom Type Description
200 OK

Device

Succès
Other Status Codes

Error

Réponse d’erreur reçue du service IoT Central.

En-têtes

x-ms-error-code: string

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom Description
user_impersonation Emprunter l’identité de votre compte d’utilisateur

Exemples

Get device by ID

Exemple de requête

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

Exemple de réponse

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

Définitions

Nom Description
Device

Définition de l’appareil.
Error

Définition de l’erreur de réponse.
ErrorDetails

Informations détaillées de l’erreur.

Device

Définition de l’appareil.

Nom Type Description
displayName

string

Nom complet de l’appareil.
enabled

boolean

Indique si la connexion de l’appareil à IoT Central a été activée.
etag

string

ETag utilisé pour éviter les conflits dans les mises à jour des appareils.
id

string

ID unique de l’appareil.
organizations

string[]

Liste des ID de organization dont l’appareil fait partie, un seul organization est pris en charge aujourd’hui, plusieurs organisations seront bientôt prises en charge.
provisioned

boolean

Indique si des ressources ont été allouées pour l’appareil.
simulated

boolean

Indique si l’appareil est simulé.
template

string

Définition du modèle d’appareil pour l’appareil.

Error

Définition de l’erreur de réponse.

Nom Type Description
error

ErrorDetails

Détails de l’erreur pour la requête actuelle.

ErrorDetails

Informations détaillées de l’erreur.

Nom Type Description
code

string

Code d’erreur.
message

string

Détails du message d’erreur.
requestId

string

ID de corrélation pour la requête actuelle.
time

string

Heure à laquelle la demande d’erreur a échoué.