Runtime Registration - Register Device

Registers the devices.

PUT https://global.azure-devices-provisioning.net/{idScope}/registrations/{registrationId}/register?api-version=2019-03-31

URI Parameters

Name In Required Type Description
idScope
path True
  • string
registrationId
path True
  • string

The registration ID is alphanumeric, lowercase, and may contain hyphens.

api-version
query True
  • string

The API version to use for the request. Supported versions include: 2019-03-31

Request Body

Name Type Description
payload
  • object

Custom allocation payload.

registrationId
  • string

Registration Id.

tpm

Tpm.

Responses

Name Type Description
200 OK

Success

202 Accepted

Success

Headers

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

Error response

Definitions

DeviceRegistration

Device registration.

DeviceRegistrationResult

Device registration result.

ProvisioningServiceErrorDetails

Contains the properties of an error returned by the Azure IoT Hub Provisioning Service.

RegistrationOperationStatus

Registration operation status.

SymmetricKeyRegistrationResult

Registration result returned when using SymmetricKey attestation.

TpmAttestation

Attestation via TPM.

TpmRegistrationResult

TPM registration result.

X509CertificateInfo

X509 certificate info.

X509RegistrationResult

X509 registration result.

DeviceRegistration

Device registration.

Name Type Description
payload
  • object

Custom allocation payload.

registrationId
  • string

Registration Id.

tpm

Tpm.

DeviceRegistrationResult

Device registration result.

Name Type Description
assignedHub
  • string

Assigned Azure IoT Hub.

createdDateTimeUtc
  • string

Registration create date time (in UTC).

deviceId
  • string

Device ID.

errorCode
  • integer

Error code.

errorMessage
  • string

Error message.

etag
  • string

The entity tag associated with the resource.

lastUpdatedDateTimeUtc
  • string

Last updated date time (in UTC).

payload
  • object

Custom allocation payload returned from the webhook to the device.

registrationId
  • string

The registration ID is alphanumeric, lowercase, and may contain hyphens.

status enum:
  • assigned
  • assigning
  • disabled
  • failed
  • unassigned

Enrollment status.

substatus enum:
  • deviceDataMigrated
  • deviceDataReset
  • initialAssignment

Substatus for 'Assigned' devices. Possible values include - 'initialAssignment': Device has been assigned to an IoT hub for the first time, 'deviceDataMigrated': Device has been assigned to a different IoT hub and its device data was migrated from the previously assigned IoT hub. Device data was removed from the previously assigned IoT hub, 'deviceDataReset': Device has been assigned to a different IoT hub and its device data was populated from the initial state stored in the enrollment. Device data was removed from the previously assigned IoT hub.

symmetricKey

Registration result returned when using SymmetricKey attestation.

tpm

Registration result returned when using TPM attestation.

x509

Registration result returned when using X509 attestation.

ProvisioningServiceErrorDetails

Contains the properties of an error returned by the Azure IoT Hub Provisioning Service.

Name Type Description
errorCode
  • integer
info
  • object
message
  • string
timestampUtc
  • string
trackingId
  • string

RegistrationOperationStatus

Registration operation status.

Name Type Description
operationId
  • string

Operation ID.

registrationState

Device registration status.

status enum:
  • assigned
  • assigning
  • disabled
  • failed
  • unassigned

Device enrollment status.

SymmetricKeyRegistrationResult

Registration result returned when using SymmetricKey attestation.

Name Type Description
enrollmentGroupId
  • string

TpmAttestation

Attestation via TPM.

Name Type Description
endorsementKey
  • string
storageRootKey
  • string

TpmRegistrationResult

TPM registration result.

Name Type Description
authenticationKey
  • string

X509CertificateInfo

X509 certificate info.

Name Type Description
issuerName
  • string
notAfterUtc
  • string
notBeforeUtc
  • string
serialNumber
  • string
sha1Thumbprint
  • string
sha256Thumbprint
  • string
subjectName
  • string
version
  • integer

X509RegistrationResult

X509 registration result.

Name Type Description
certificateInfo

X509 certificate info.

enrollmentGroupId
  • string
signingCertificateInfo

X509 certificate info.