Partager via

Runtime Registration - Register Device

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

Inscrit les appareils.

PUT https://global.azure-devices-provisioning.net/{idScope}/registrations/{registrationId}/register?api-version=2021-10-01

Paramètres URI

Nom Dans Obligatoire Type Description
idScope
 path True

string

registrationId
 path True

string

L’ID d’enregistrement est alphanumérique, en minuscules et peut contenir des traits d’union.
api-version
 query True

string

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

Corps de la demande

Nom Type Description
payload

object

registrationId

string

L’ID d’inscription est une chaîne qui ne respecte pas 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.
tpm

TpmAttestation

Attestation via TPM.

Réponses

Nom Type Description
200 OK

RegistrationOperationStatus

Succès
202 Accepted

RegistrationOperationStatus

Accepté

En-têtes

  • Location: string
  • retry-after: integer
Other Status Codes

ProvisioningServiceErrorDetails

Réponse d’erreur

En-têtes

x-ms-error-code: string

Définitions

Nom Description
DeviceRegistration

Inscription de l'appareil.
DeviceRegistrationResult

Résultat de l’inscription de l’appareil.
ProvisioningServiceErrorDetails

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

Opération d’inscription status.
SymmetricKeyRegistrationResult

Résultat d’inscription retourné lors de l’utilisation de l’attestation SymmetricKey.
TpmAttestation

Attestation via TPM.
TpmRegistrationResult

Résultat de l’inscription TPM.
X509CertificateInfo

Informations de certificat X509.
X509RegistrationResult

Résultat de l’inscription X509.

DeviceRegistration

Inscription de l'appareil.

Nom Type Description
payload

object

registrationId

string

L’ID d’inscription est une chaîne qui ne respecte pas 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.
tpm

TpmAttestation

Attestation via TPM.

DeviceRegistrationResult

Résultat de l’inscription de l’appareil.

Nom Type Description
assignedHub

string

Azure IoT Hub affectés.
createdDateTimeUtc

string

Date et heure de la création de l’inscription (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 et 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 d’une inscription. Chaîne ne respectant pas 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

Status d’inscription.
substatus enum:
  • deviceDataMigrated
  • deviceDataReset
  • initialAssignment
  • reprovisionedToInitialAssignment

Sous-état pour les appareils « affectés ». Les valeurs possibles sont les suivantes : « 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 affecté. 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 d’appareil ont été supprimées du hub IoT précédemment affecté, « reprovisionedToInitialAssignment » : l’appareil a été réapprovisionné sur un hub IoT précédemment affecté.
symmetricKey

SymmetricKeyRegistrationResult

Résultat d’inscription retourné lors de l’utilisation de l’attestation SymmetricKey.
tpm

TpmRegistrationResult

Résultat de l’inscription TPM.
x509

X509RegistrationResult

Résultat de l’inscription X509.

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

RegistrationOperationStatus

Opération d’inscription status.

Nom Type Description
operationId

string

ID d’opération
registrationState

DeviceRegistrationResult

Résultat de l’inscription de l’appareil.
status enum:
  • assigned
  • assigning
  • disabled
  • failed
  • unassigned

Status d’inscription d’appareil.

SymmetricKeyRegistrationResult

Résultat d’inscription retourné lors de l’utilisation de l’attestation SymmetricKey.

Nom Type Description
enrollmentGroupId

string

TpmAttestation

Attestation via TPM.

Nom Type Description
endorsementKey

string

storageRootKey

string

TpmRegistrationResult

Résultat de l’inscription TPM.

Nom Type Description
authenticationKey

string

Clé d’authentification chiffrée.

X509CertificateInfo

Informations de certificat X509.

Nom Type Description
issuerName

string

notAfterUtc

string

notBeforeUtc

string

serialNumber

string

sha1Thumbprint

string

sha256Thumbprint

string

subjectName

string

version

integer

X509RegistrationResult

Résultat de l’inscription X509.

Nom Type Description
certificateInfo

X509CertificateInfo

Informations de certificat X509.
enrollmentGroupId

string

signingCertificateInfo

X509CertificateInfo

Informations de certificat X509.