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	Область действия экземпляра DPS.
registrationId	path	True	string	Регистрационный идентификатор имеет буквенно-цифровую форму, строчную букву и может содержать дефисы.
api-version	query	True	string minLength: 1	Версия API, используемая для данной операции.

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

Имя	Тип	Описание
payload		Любой объект
registrationId	string	Идентификатор регистрации — это строка без регистра (до 128 символов) из буквенно-цифровых символов плюс некоторых специальных символов : . _ -. В начале и в конце никаких особых символов запрещено.
tpm	TpmAttestation	Аттестация через TPM.

Ответы

Имя	Тип	Описание
200 OK	RegistrationOperationStatus	Запрос выполнен успешно.
202 Accepted	RegistrationOperationStatus	Запрос был принят для обработки, но обработка еще не завершена. Заголовки Location: string retry-after: integer
Other Status Codes	ProvisioningServiceErrorDetails	Непредвиденное сообщение об ошибке. Заголовки x-ms-error-code: string

Имя

Тип

Описание

200 OK

RegistrationOperationStatus

Запрос выполнен успешно.

202 Accepted

RegistrationOperationStatus

Запрос был принят для обработки, но обработка еще не завершена.

Заголовки

Location: string
retry-after: integer

Other Status Codes

ProvisioningServiceErrorDetails

Непредвиденное сообщение об ошибке.

Заголовки

x-ms-error-code: string

Примеры

RuntimeRegistration_RegisterDevice_MaximumSet_Gen

RuntimeRegistration_RegisterDevice_MinimumSet_Gen

RuntimeRegistration_RegisterDevice_MaximumSet_Gen

Образец запроса

HTTP

PUT https://global.azure-devices-provisioning.net/ofvgihmgllfsmm/registrations/macgmlbhpb/register?api-version=2021-10-01

{
  "payload": {},
  "registrationId": "qypnuerjeunzogqdezhjgisfr",
  "tpm": {
    "endorsementKey": "sbvvzftylrpsetexcmnijtdezppq",
    "storageRootKey": "juohyrayid"
  }
}

Пример ответа

Код состояния:: 200

{
  "operationId": "xosjboksmobnotwgqejpvxiwi",
  "registrationState": {
    "assignedHub": "ljexps",
    "createdDateTimeUtc": "2025-10-01T17:41:56.535Z",
    "deviceId": "hjvdlwpugzlk",
    "errorCode": 13,
    "errorMessage": "zpctqazbkbiqjkwosis",
    "etag": "hjtelksspyfzhmet",
    "lastUpdatedDateTimeUtc": "2025-10-01T17:41:56.535Z",
    "payload": {},
    "registrationId": "urejrffpkqneou",
    "status": "unassigned",
    "substatus": "initialAssignment",
    "symmetricKey": {
      "enrollmentGroupId": "w"
    },
    "tpm": {
      "authenticationKey": "sofbxakhjrxpiyysjjxkx"
    },
    "x509": {
      "certificateInfo": {
        "issuerName": "pvpbipnhcahytrcq",
        "notAfterUtc": "2025-10-01T17:41:56.534Z",
        "notBeforeUtc": "2025-10-01T17:41:56.534Z",
        "serialNumber": "jjvdijgwgpagrjdi",
        "sha1Thumbprint": "guqltcfgusf",
        "sha256Thumbprint": "ysryarleygpkejrjlwuxacvcwbxqw",
        "subjectName": "jtsfqnbcmmott",
        "version": 20
      },
      "enrollmentGroupId": "qbw",
      "signingCertificateInfo": {
        "issuerName": "pvpbipnhcahytrcq",
        "notAfterUtc": "2025-10-01T17:41:56.534Z",
        "notBeforeUtc": "2025-10-01T17:41:56.534Z",
        "serialNumber": "jjvdijgwgpagrjdi",
        "sha1Thumbprint": "guqltcfgusf",
        "sha256Thumbprint": "ysryarleygpkejrjlwuxacvcwbxqw",
        "subjectName": "jtsfqnbcmmott",
        "version": 20
      }
    }
  },
  "status": "unassigned"
}

Код состояния:: 202

{
  "operationId": "xosjboksmobnotwgqejpvxiwi",
  "registrationState": {
    "assignedHub": "ljexps",
    "createdDateTimeUtc": "2025-10-01T17:41:56.535Z",
    "deviceId": "hjvdlwpugzlk",
    "errorCode": 13,
    "errorMessage": "zpctqazbkbiqjkwosis",
    "etag": "hjtelksspyfzhmet",
    "lastUpdatedDateTimeUtc": "2025-10-01T17:41:56.535Z",
    "payload": {},
    "registrationId": "urejrffpkqneou",
    "status": "unassigned",
    "substatus": "initialAssignment",
    "symmetricKey": {
      "enrollmentGroupId": "w"
    },
    "tpm": {
      "authenticationKey": "sofbxakhjrxpiyysjjxkx"
    },
    "x509": {
      "certificateInfo": {
        "issuerName": "pvpbipnhcahytrcq",
        "notAfterUtc": "2025-10-01T17:41:56.534Z",
        "notBeforeUtc": "2025-10-01T17:41:56.534Z",
        "serialNumber": "jjvdijgwgpagrjdi",
        "sha1Thumbprint": "guqltcfgusf",
        "sha256Thumbprint": "ysryarleygpkejrjlwuxacvcwbxqw",
        "subjectName": "jtsfqnbcmmott",
        "version": 20
      },
      "enrollmentGroupId": "qbw",
      "signingCertificateInfo": {
        "issuerName": "pvpbipnhcahytrcq",
        "notAfterUtc": "2025-10-01T17:41:56.534Z",
        "notBeforeUtc": "2025-10-01T17:41:56.534Z",
        "serialNumber": "jjvdijgwgpagrjdi",
        "sha1Thumbprint": "guqltcfgusf",
        "sha256Thumbprint": "ysryarleygpkejrjlwuxacvcwbxqw",
        "subjectName": "jtsfqnbcmmott",
        "version": 20
      }
    }
  },
  "status": "unassigned"
}

RuntimeRegistration_RegisterDevice_MinimumSet_Gen

Образец запроса

HTTP

PUT https://global.azure-devices-provisioning.net/gwgyqmyyzzzjpjmxml/registrations/tuodrxicixbbekaajxfiyvoxsbe/register?api-version=2021-10-01

{}

Пример ответа

Код состояния:: 200

{
  "operationId": "xosjboksmobnotwgqejpvxiwi"
}

Код состояния:: 202

{
  "operationId": "xosjboksmobnotwgqejpvxiwi"
}

Определения

Имя	Описание
AssignedDeviceSubstatus	Подстатус для «Назначенных» устройств. Возможные значения включают - 'initialAssignment': устройство впервые было назначено IoT-хабу, 'deviceDataMigrated': устройство было назначено другому IoT-хабу, а его данные были перенесены с ранее назначенного IoT-хаба. Данные устройства были удалены из ранее назначенного IoT-хаба 'deviceDataReset': устройство было назначено на другой IoT-хаб, и его данные были заполнены из исходного состояния, сохранённого в регистрации. Данные устройства были удалены из ранее назначенного хаба IoT, 'reprovisionedToInitialAssignment': устройство было перераспределено на ранее назначенный хаб IoT.
DeviceRegistration	Регистрация устройства.
DeviceRegistrationResult	Результат регистрации устройства.
EnrollmentStatus	Статус зачисления.
ProvisioningServiceErrorDetails	Содержит свойства ошибки, возвращаемой сервисом Azure IoT Hub Provisioning Service.
RegistrationOperationStatus	Статус регистрационной операции.
SymmetricKeyRegistrationResult	Результат регистрации возвращался при использовании аттестации SymmetricKey.
TpmAttestation	Аттестация через TPM.
TpmRegistrationResult	Результат регистрации TPM.
X509CertificateInfo	Информация о сертификате X509.
X509RegistrationResult	Результат регистрации X509.

AssignedDeviceSubstatus

Перечисление

Подстатус для «Назначенных» устройств. Возможные значения включают - 'initialAssignment': устройство впервые было назначено IoT-хабу, 'deviceDataMigrated': устройство было назначено другому IoT-хабу, а его данные были перенесены с ранее назначенного IoT-хаба. Данные устройства были удалены из ранее назначенного IoT-хаба 'deviceDataReset': устройство было назначено на другой IoT-хаб, и его данные были заполнены из исходного состояния, сохранённого в регистрации. Данные устройства были удалены из ранее назначенного хаба IoT, 'reprovisionedToInitialAssignment': устройство было перераспределено на ранее назначенный хаб IoT.

Значение	Описание
initialAssignment	initialAssignment
deviceDataMigrated	deviceDataMigrated
deviceDataReset	deviceDataReset
reprovisionedToInitialAssignment	reprovisionedToInitialAssignment

DeviceRegistration

Объект

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

Имя	Тип	Описание
payload		Любой объект
registrationId	string	Идентификатор регистрации — это строка без регистра (до 128 символов) из буквенно-цифровых символов плюс некоторых специальных символов : . _ -. В начале и в конце никаких особых символов запрещено.
tpm	TpmAttestation	Аттестация через TPM.

DeviceRegistrationResult

Объект

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

Имя	Тип	Описание
assignedHub	string	Назначен Azure IoT Hub.
createdDateTimeUtc	string (date-time)	Регистрация создаёт дату времени (в UTC).
deviceId	string	Идентификатор устройства.
errorCode	integer (int32)	Код ошибки.
errorMessage	string	Сообщение об ошибке.
etag	string	Тег сущности, связанный с ресурсом.
lastUpdatedDateTimeUtc	string (date-time)	Последнее обновленное время (в UTC).
payload		Любой объект
registrationId	string	Этот идентификатор используется для уникальной идентификации регистрации устройства при регистрации. Строка, не чувствительная к регистру (до 128 символов) из буквенно-цифровых символов плюс некоторые специальные символы: . _ -. В начале и в конце никаких особых символов запрещено.
status	EnrollmentStatus	Статус зачисления.
substatus	AssignedDeviceSubstatus	Подстатус для «Назначенных» устройств. Возможные значения включают - 'initialAssignment': устройство впервые было назначено IoT-хабу, 'deviceDataMigrated': устройство было назначено другому IoT-хабу, а его данные были перенесены с ранее назначенного IoT-хаба. Данные устройства были удалены из ранее назначенного IoT-хаба 'deviceDataReset': устройство было назначено на другой IoT-хаб, и его данные были заполнены из исходного состояния, сохранённого в регистрации. Данные устройства были удалены из ранее назначенного хаба IoT, 'reprovisionedToInitialAssignment': устройство было перераспределено на ранее назначенный хаб IoT.
symmetricKey	SymmetricKeyRegistrationResult	Результат регистрации возвращался при использовании аттестации SymmetricKey.
tpm	TpmRegistrationResult	Результат регистрации TPM.
x509	X509RegistrationResult	Результат регистрации X509.

EnrollmentStatus

Перечисление

Статус зачисления.

Значение	Описание
unassigned	unassigned
assigning	Присваивание
assigned	назначен
failed	ошибка
disabled	disabled (выключено)

ProvisioningServiceErrorDetails

Объект

Содержит свойства ошибки, возвращаемой сервисом Azure IoT Hub Provisioning Service.

Имя	Тип	Описание
errorCode	integer (int32)	Числовой код ошибки.
info	object	Словарь строки <>
message	string	Сообщение об ошибке.
timestampUtc	string (date-time)	Временная метка ошибки (UTC).
trackingId	string	Идентификатор отслеживания ошибок.

RegistrationOperationStatus

Объект

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

Имя	Тип	Описание
operationId	string minLength: 1	Идентификатор операции.
registrationState	DeviceRegistrationResult	Результат регистрации устройства.
status	EnrollmentStatus	Статус регистрации устройства.

SymmetricKeyRegistrationResult

Объект

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

Имя	Тип	Описание
enrollmentGroupId	string	Идентификатор группы регистрации.

TpmAttestation

Объект

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

Имя	Тип	Описание
endorsementKey	string	Ключ одобрения TPM.
storageRootKey	string	Корневый ключ TPM хранилища.

TpmRegistrationResult

Объект

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

Имя	Тип	Описание
authenticationKey	string	Зашифрованный ключ аутентификации.

X509CertificateInfo

Объект

Информация о сертификате X509.

Имя	Тип	Описание
issuerName	string	Имя издателя сертификата.
notAfterUtc	string (date-time)	Срок действия сертификата (UTC).
notBeforeUtc	string (date-time)	Дата начала действия сертификата (UTC).
serialNumber	string	Серийный номер сертификата.
sha1Thumbprint	string	Отпечаток пальца SHA-1 сертификата.
sha256Thumbprint	string	Отпечаток пальца SHA-256 сертификата.
subjectName	string	Имя предмета сертификата.
version	integer (int32)	Версия сертификата.

X509RegistrationResult

Объект

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

Имя	Тип	Описание
certificateInfo	X509CertificateInfo	Информация о сертификате X509.
enrollmentGroupId	string	Идентификатор группы регистрации.
signingCertificateInfo	X509CertificateInfo	Информация о сертификате X509.