Device Registration State - Get

  • Référence
Service:
IoT Hub Device Provisioning Service
API Version:
2021-10-01

Obtient l’état d’inscription de l’appareil.

GET https://your-dps.azure-devices-provisioning.net/registrations/{id}?api-version=2021-10-01

Paramètres URI

Nom Dans Obligatoire Type Description
id
 path True

string

ID d’inscription.
api-version
 query True

string

Version de l’API à utiliser pour la requête. Versions prises en charge : 01/10/2021

Réponses

Nom Type Description
200 OK

DeviceRegistrationState

Succès
Other Status Codes

ProvisioningServiceErrorDetails

Réponse d’erreur

Headers

x-ms-error-code: string

Définitions

Nom Description
DeviceRegistrationState

État d’inscription de l’appareil.
ProvisioningServiceErrorDetails

Contient les propriétés d’une erreur retournée par le service d’approvisionnement Azure IoT Hub.

DeviceRegistrationState

État d’inscription de l’appareil.

Nom Type Description
assignedHub

string

Azure IoT Hub affectée.
createdDateTimeUtc

string

L’inscription crée la date d’heure (en UTC).
deviceId

string

ID de périphérique.
errorCode

integer

Code d’erreur.
errorMessage

string

Message d’erreur.
etag

string

Balise d’entité associée à la ressource.
lastUpdatedDateTimeUtc

string

Date d’heure de la dernière mise à jour (en UTC).
payload

object

registrationId

string

Cet ID est utilisé pour identifier de manière unique une inscription d’appareil. Chaîne non sensible à la casse (jusqu’à 128 caractères) de caractères alphanumériques plus certains caractères spéciaux : . _ -. Aucun caractère spécial autorisé au début ou à la fin.
status enum:
  • assigned
  • assigning
  • disabled
  • failed
  • unassigned

Inscription status.
substatus enum:
  • deviceDataMigrated
  • deviceDataReset
  • initialAssignment
  • reprovisionedToInitialAssignment

Sous-état pour les appareils « affectés ». Les valeurs possibles incluent : « initialAssignment » : l’appareil a été affecté à un hub IoT pour la première fois, « deviceDataMigrated » : l’appareil a été affecté à un autre hub IoT et ses données d’appareil ont été migrées à partir du hub IoT précédemment attribué. Les données d’appareil ont été supprimées du hub IoT précédemment affecté, « deviceDataReset » : l’appareil a été affecté à un autre hub IoT et ses données d’appareil ont été remplies à partir de l’état initial stocké dans l’inscription. Les données de l’appareil ont été supprimées du hub IoT précédemment attribué, « reprovisionedToInitialAssignment » : l’appareil a été réapprovisionné sur un hub IoT précédemment affecté.

ProvisioningServiceErrorDetails

Contient les propriétés d’une erreur retournée par le service d’approvisionnement Azure IoT Hub.

Nom Type Description
errorCode

integer

info

object

message

string

timestampUtc

string

trackingId

string