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

Runtime Registration - Device Registration Status Lookup

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

Возвращает состояние регистрации устройства.

POST https://global.azure-devices-provisioning.net/{idScope}/registrations/{registrationId}?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

Аттестация через TPM.

Ответы

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

DeviceRegistrationResult

Успех
Other Status Codes

ProvisioningServiceErrorDetails

Ответ на ошибку

Заголовки

x-ms-error-code: string

Определения

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

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

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

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

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

Аттестация через TPM.
TpmRegistrationResult

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

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

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

DeviceRegistration

Object

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

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

object

registrationId

string

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

TpmAttestation

Аттестация через TPM.

DeviceRegistrationResult

Object

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

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

string

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

string (date-time)

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

string

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

integer (int32)

Код ошибки.
errorMessage

string

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

string

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

string (date-time)

Последнее обновление даты (в формате 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

Object

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

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

integer (int32)

info

object

message

string

timestampUtc

string (date-time)

trackingId

string

SymmetricKeyRegistrationResult

Object

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

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

string

TpmAttestation

Object

Аттестация через TPM.

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

string

storageRootKey

string

TpmRegistrationResult

Object

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

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

string

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

X509CertificateInfo

Object

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

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

string

notAfterUtc

string (date-time)

notBeforeUtc

string (date-time)

serialNumber

string

sha1Thumbprint

string

sha256Thumbprint

string

subjectName

string

version

integer (int32)

X509RegistrationResult

Object

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

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

X509CertificateInfo

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

string

signingCertificateInfo

X509CertificateInfo

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