Partager via

Runtime Registration - Register Device

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’inscription est alphanumérique, minuscule et peut contenir des traits d’union.
api-version
 query True

string

Version de l’API à utiliser pour la requête. Les versions prises en charge sont les suivantes : 2021-10-01

Corps de la demande

Nom Type Description
payload

object

registrationId

string

L’ID d’inscription est une 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 n’est 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 Azure IoT Hub Provisioning.
RegistrationOperationStatus

État de l’opération d’inscription.
SymmetricKeyRegistrationResult

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

Attestation via TPM.
TpmRegistrationResult

Résultat de l’inscription du module TPM.
X509CertificateInfo

Informations sur le certificat X509.
X509RegistrationResult

Résultat de l’inscription X509.

DeviceRegistration

Object

Inscription de l’appareil

Nom Type Description
payload

object

registrationId

string

L’ID d’inscription est une 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 n’est autorisé au début ou à la fin.
tpm

TpmAttestation

Attestation via TPM.

DeviceRegistrationResult

Object

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

Nom Type Description
assignedHub

string

Affectation d’Azure IoT Hub.
createdDateTimeUtc

string (date-time)

Date de création de l’inscription (en UTC).
deviceId

string

ID de l’appareil.
errorCode

integer (int32)

Code d’erreur.
errorMessage

string

Message d'erreur.
etag

string

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

string (date-time)

Heure de la date 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 non sensible à la casse (jusqu’à 128 caractères) de caractères alphanumériques plus certains caractères spéciaux : . _ -. Aucun caractère spécial n’est autorisé au début ou à la fin.
status enum:
  • assigned
  • assigning
  • disabled
  • failed
  • unassigned

État de l’inscription.
substatus enum:
  • deviceDataMigrated
  • deviceDataReset
  • initialAssignment
  • reprovisionedToInitialAssignment

Sous-état pour les appareils « Attribué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 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 de l’inscription retourné lors de l’utilisation de l’attestation SymmetricKey.
tpm

TpmRegistrationResult

Résultat de l’inscription du module TPM.
x509

X509RegistrationResult

Résultat de l’inscription X509.

ProvisioningServiceErrorDetails

Object

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

Nom Type Description
errorCode

integer (int32)

info

object

message

string

timestampUtc

string (date-time)

trackingId

string

RegistrationOperationStatus

Object

État de l’opération d’inscription.

Nom Type Description
operationId

string

minLength: 1

ID d’opération.
registrationState

DeviceRegistrationResult

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

État de l’inscription de l’appareil.

SymmetricKeyRegistrationResult

Object

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

Nom Type Description
enrollmentGroupId

string

TpmAttestation

Object

Attestation via TPM.

Nom Type Description
endorsementKey

string

storageRootKey

string

TpmRegistrationResult

Object

Résultat de l’inscription du module TPM.

Nom Type Description
authenticationKey

string

Clé d’authentification chiffrée.

X509CertificateInfo

Object

Informations sur le certificat X509.

Nom Type Description
issuerName

string

notAfterUtc

string (date-time)

notBeforeUtc

string (date-time)

serialNumber

string

sha1Thumbprint

string

sha256Thumbprint

string

subjectName

string

version

integer (int32)

X509RegistrationResult

Object

Résultat de l’inscription X509.

Nom Type Description
certificateInfo

X509CertificateInfo

Informations sur le certificat X509.
enrollmentGroupId

string

signingCertificateInfo

X509CertificateInfo

Informations sur le certificat X509.