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 registro dos dispositivos neste grupo de registro.

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 ser usada para a solicitação. As versões suportadas incluem: 2021-10-01

Cabeçalho do Pedido

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

integer (int32)

tamanho da página
x-ms-continuation

string

token de continuação

Respostas

Name Tipo Description
200 OK

DeviceRegistrationState[]

Sucesso

Cabeçalhos

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

ProvisioningServiceErrorDetails

Resposta de erro

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 retornado pelo Serviço de Provisionamento do Hub IoT do Azure.

DeviceRegistrationState

Object

Estado de registo do dispositivo.

Name Tipo Description
assignedHub

string

Atribuído o Hub IoT do Azure.
createdDateTimeUtc

string (date-time)

O registo cria data e hora (em UTC).
deviceId

string

ID do dispositivo.
errorCode

integer (int32)

Código de erro.
errorMessage

string

Mensagem de erro.
etag

string

A marca de entidade associada ao recurso.
lastUpdatedDateTimeUtc

string (date-time)

Data da última atualização, hora (em UTC).
payload

object

registrationId

string

Esse id é usado para identificar exclusivamente um registro de dispositivo de uma inscrição. Uma cadeia de caracteres que não diferencia maiúsculas de minúsculas (até 128 caracteres) de caracteres alfanuméricos mais certos caracteres especiais : . _ -. Não são permitidos caracteres especiais no início ou no fim.
status enum:
  • assigned
  • assigning
  • disabled
  • failed
  • unassigned

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

Substatus 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 seus dados de dispositivo foram migrados do hub IoT atribuído anteriormente. Os dados do dispositivo foram removidos do hub IoT atribuído anteriormente, 'deviceDataReset': o dispositivo foi atribuído a um hub IoT diferente e seus dados de dispositivo foram preenchidos a partir do estado inicial armazenado no registro. Os dados do dispositivo foram removidos do hub IoT atribuído anteriormente, 'reprovisionedToInitialAssignment': o dispositivo foi reprovisionado para um hub IoT atribuído anteriormente.

ProvisioningServiceErrorDetails

Object

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

Name Tipo Description
errorCode

integer (int32)

info

object

message

string

timestampUtc

string (date-time)

trackingId

string