Поделиться через

Runtime Registration - Register Device

  • Ссылка
Служба:
IoT Hub Device Provisioning Service
Версия API:
2021-10-01

Регистрирует устройства.

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

Параметры URI

Имя В Обязательно Тип Описание
idScope
 path True

string

registrationId
 path True

string

Этот идентификатор состоит из цифр и букв нижнего регистра и может содержать дефисы.
api-version
 query True

string

Версия API для использования в запросе. Поддерживаемые версии: 2021-10-01

Текст запроса

Имя Тип Описание
payload

object

registrationId

string

Идентификатор регистрации — это строка без учета регистра (длиной до 128 символов) буквенно-цифровых символов плюс определенные специальные символы: . _ -. Специальные символы не допускаются в начале или конце.
tpm

TpmAttestation

Аттестация с помощью доверенного платформенного модуля.

Ответы

Имя Тип Описание
200 OK

RegistrationOperationStatus

Успешное завершение
202 Accepted

RegistrationOperationStatus

Принято

Заголовки

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

ProvisioningServiceErrorDetails

Сообщение об ошибке

Заголовки

x-ms-error-code: string

Определения

Имя Описание
DeviceRegistration

Регистрация устройства.
DeviceRegistrationResult

Результат регистрации устройства.
ProvisioningServiceErrorDetails

Содержит свойства ошибки, возвращаемой службой подготовки Центр Интернета вещей Azure.
RegistrationOperationStatus

Состояние операции регистрации.
SymmetricKeyRegistrationResult

Результат регистрации возвращается при использовании аттестации SymmetricKey.
TpmAttestation

Аттестация с помощью доверенного платформенного модуля.
TpmRegistrationResult

Результат регистрации доверенного платформенного модуля.
X509CertificateInfo

Сведения о сертификате X509.
X509RegistrationResult

Результат регистрации X509.

DeviceRegistration

Регистрация устройства.

Имя Тип Описание
payload

object

registrationId

string

Идентификатор регистрации — это строка без учета регистра (длиной до 128 символов) буквенно-цифровых символов плюс определенные специальные символы: . _ -. Специальные символы не допускаются в начале или конце.
tpm

TpmAttestation

Аттестация с помощью доверенного платформенного модуля.

DeviceRegistrationResult

Результат регистрации устройства.

Имя Тип Описание
assignedHub

string

Назначенные Центр Интернета вещей Azure.
createdDateTimeUtc

string

Дата создания регистрации (в формате UTC).
deviceId

string

Идентификатор устройства.
errorCode

integer

Код ошибки.
errorMessage

string

Сообщение об ошибке.
etag

string

Тег сущности, связанный с ресурсом.
lastUpdatedDateTimeUtc

string

Дата и время последнего обновления (в формате UTC).
payload

object

registrationId

string

Этот идентификатор используется для уникальной идентификации регистрации устройства. Строка без учета регистра (длиной до 128 символов) буквенно-цифровых символов плюс некоторые специальные символы: . _ -. Специальные символы не допускаются в начале или конце.
status enum:
  • assigned
  • assigning
  • disabled
  • failed
  • unassigned

Состояние регистрации.
substatus enum:
  • deviceDataMigrated
  • deviceDataReset
  • initialAssignment
  • reprovisionedToInitialAssignment

Подсостояние для назначенных устройств. Возможные значения: initialAssignment: устройство было назначено Центру Интернета вещей в первый раз, deviceDataMigrated: устройство было назначено другому центру Интернета вещей, и его данные устройства были перенесены из ранее назначенного Центра Интернета вещей. Данные устройства были удалены из ранее назначенного Центра Интернета вещей deviceDataReset. Устройство было назначено другому центру Интернета вещей, и его данные устройства были заполнены из исходного состояния, хранящегося в регистрации. Данные устройства были удалены из ранее назначенного Центра Интернета вещей reprovisionedToInitialAssignment: устройство было повторно подготовлено к ранее назначенному Центру Интернета вещей.
symmetricKey

SymmetricKeyRegistrationResult

Результат регистрации возвращается при использовании аттестации SymmetricKey.
tpm

TpmRegistrationResult

Результат регистрации доверенного платформенного модуля.
x509

X509RegistrationResult

Результат регистрации X509.

ProvisioningServiceErrorDetails

Содержит свойства ошибки, возвращаемой службой подготовки Центр Интернета вещей Azure.

Имя Тип Описание
errorCode

integer

info

object

message

string

timestampUtc

string

trackingId

string

RegistrationOperationStatus

Состояние операции регистрации.

Имя Тип Описание
operationId

string

Идентификатор операции.
registrationState

DeviceRegistrationResult

Результат регистрации устройства.
status enum:
  • assigned
  • assigning
  • disabled
  • failed
  • unassigned

Состояние регистрации устройства.

SymmetricKeyRegistrationResult

Результат регистрации возвращается при использовании аттестации SymmetricKey.

Имя Тип Описание
enrollmentGroupId

string

TpmAttestation

Аттестация с помощью доверенного платформенного модуля.

Имя Тип Описание
endorsementKey

string

storageRootKey

string

TpmRegistrationResult

Результат регистрации доверенного платформенного модуля.

Имя Тип Описание
authenticationKey

string

Зашифрованный ключ проверки подлинности.

X509CertificateInfo

Сведения о сертификате X509.

Имя Тип Описание
issuerName

string

notAfterUtc

string

notBeforeUtc

string

serialNumber

string

sha1Thumbprint

string

sha256Thumbprint

string

subjectName

string

version

integer

X509RegistrationResult

Результат регистрации X509.

Имя Тип Описание
certificateInfo

X509CertificateInfo

Сведения о сертификате X509.
enrollmentGroupId

string

signingCertificateInfo

X509CertificateInfo

Сведения о сертификате X509.