Share via

Device Registration State - Query

  • Ссылка
Service:
IoT Hub Device Provisioning Service
API Version:
2021-10-01

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

POST https://your-dps.azure-devices-provisioning.net/registrations/{id}/query?api-version=2021-10-01

Параметры URI

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

string

Идентификатор группы регистрации.
api-version
 query True

string

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

Заголовок запроса

Имя Обязательно Тип Описание
x-ms-max-item-count

integer

int32

pageSize
x-ms-continuation

string

маркер продолжения

Ответы

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

DeviceRegistrationState[]

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

Headers

  • x-ms-continuation: string
  • x-ms-max-item-count: integer
  • x-ms-item-type: string
Other Status Codes

ProvisioningServiceErrorDetails

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

Headers

x-ms-error-code: string

Определения

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

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

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

DeviceRegistrationState

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

Имя Тип Описание
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: устройство было повторно подготовлено для ранее назначенного Центра Интернета вещей.

ProvisioningServiceErrorDetails

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

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

integer

info

object

message

string

timestampUtc

string

trackingId

string