Partilhar via

Device Registration State - Query

  • Referência
Serviço:
IoT Hub Device Provisioning Service
Versão da API:
2021-10-01

Obtém o estado de registo dos dispositivos neste enrollmentGroup.

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

Parâmetros do URI

Name Em Necessário Tipo Description
id
 path True

string

ID do grupo de inscrição.
api-version
 query True

string

A versão da API a utilizar para o pedido. As versões suportadas incluem: 2021-10-01

Cabeçalho do Pedido

Name Necessário Tipo Description
x-ms-max-item-count

integer

int32

pageSize
x-ms-continuation

string

token de continuação

Respostas

Name Tipo Description
200 OK

DeviceRegistrationState[]

Com êxito

Cabeçalhos

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

ProvisioningServiceErrorDetails

Resposta a erros

Cabeçalhos

x-ms-error-code: string

Definições

Name Description
DeviceRegistrationState

Estado de registo do dispositivo.
ProvisioningServiceErrorDetails

Contém as propriedades de um erro devolvido pelo Serviço de Aprovisionamento Hub IoT do Azure.

DeviceRegistrationState

Estado de registo do dispositivo.

Name Tipo Description
assignedHub

string

Atribuído Hub IoT do Azure.
createdDateTimeUtc

string

Data de criação do registo (em UTC).
deviceId

string

ID do dispositivo.
errorCode

integer

Código de erro.
errorMessage

string

Mensagem de erro.
etag

string

A etiqueta de entidade associada ao recurso.
lastUpdatedDateTimeUtc

string

Hora da data da última atualização (em UTC).
payload

object

registrationId

string

Este ID é utilizado para identificar exclusivamente um registo de dispositivo de uma inscrição. Uma cadeia não sensível a maiúsculas e minúsculas (até 128 carateres) de carateres alfanuméricos e determinados carateres especiais: . _ -. Não são permitidos carateres especiais no início ou no fim.
status enum:
  • assigned
  • assigning
  • disabled
  • failed
  • unassigned

Estado da inscrição.
substatus enum:
  • deviceDataMigrated
  • deviceDataReset
  • initialAssignment
  • reprovisionedToInitialAssignment

Subestado para dispositivos "Atribuídos". Os valores possíveis incluem - "initialAssignment": O dispositivo foi atribuído a um hub IoT pela primeira vez, "deviceDataMigrated": O dispositivo foi atribuído a um hub IoT diferente e os dados do dispositivo foram migrados do hub IoT atribuído anteriormente. Os dados do dispositivo foram removidos do hub IoT anteriormente atribuído, "deviceDataReset": o dispositivo foi atribuído a um hub IoT diferente e os dados do dispositivo foram preenchidos a partir do estado inicial armazenado na inscrição. Os dados do dispositivo foram removidos do hub IoT atribuído anteriormente, "reprovisionedToInitialAssignment": O dispositivo foi aprovisionado novamente num hub IoT atribuído anteriormente.

ProvisioningServiceErrorDetails

Contém as propriedades de um erro devolvido pelo Serviço de Aprovisionamento Hub IoT do Azure.

Name Tipo Description
errorCode

integer

info

object

message

string

timestampUtc

string

trackingId

string