Compartilhar via

Individual Enrollment - Query

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

Consulte os registros de registro do dispositivo.

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
api-version
 query True

string

A versão da API a ser usada para a solicitação. As versões com suporte incluem: 2021-10-01

Cabeçalho da solicitação

Nome Obrigatório Tipo Description
x-ms-max-item-count

integer (int32)

Tamanho da página
x-ms-continuation

string

Token de continuação

Corpo da solicitação

Nome Obrigatório Tipo Description
query True

string

Respostas

Nome Tipo Description
200 OK

IndividualEnrollment[]

Êxito

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

Nome Description
AttestationMechanism

Mecanismo de atestado para individualEnrollment, bem como enrollmentGroup.
CustomAllocationDefinition

Isso informa ao DPS qual webhook chamar ao usar a alocação personalizada.
DeviceCapabilities

Funcionalidades do dispositivo.
DeviceRegistrationState

Estado do registro do dispositivo.
IndividualEnrollment

O registro do dispositivo.
InitialTwin

Dispositivo gêmeo inicial. Contém um subconjunto das propriedades do Gêmeo.
InitialTwinProperties

Representa as propriedades iniciais que serão definidas no dispositivo gêmeo.
Metadata

Metadados para o TwinCollection
ProvisioningServiceErrorDetails

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

O comportamento do serviço quando um dispositivo é provisionado novamente para um hub IoT.
SymmetricKeyAttestation

Atestado via SymmetricKey.
TpmAttestation

Atestado via TPM.
TwinCollection

Representa uma coleção de propriedades em um gêmeo
X509Attestation

Atestado via X509.
X509CAReferences

Referências de AC primária e secundária.
X509CertificateInfo

Informações do certificado X509.
X509Certificates

Certificados primários e secundários
X509CertificateWithInfo

Informações de certificado e certificado

AttestationMechanism

Objeto

Mecanismo de atestado para individualEnrollment, bem como enrollmentGroup.

Nome Tipo Description
symmetricKey

SymmetricKeyAttestation

Atestado via SymmetricKey.
tpm

TpmAttestation

Atestado via TPM.
type enum:
  • none
  • symmetricKey
  • tpm
  • x509

Tipo de atestado.
x509

X509Attestation

Atestado via X509.

CustomAllocationDefinition

Objeto

Isso informa ao DPS qual webhook chamar ao usar a alocação personalizada.

Nome Tipo Description
apiVersion

string

minLength: 1

A versão da API dos tipos de serviço de provisionamento (como IndividualEnrollment) enviados na solicitação de alocação personalizada. Versão mínima com suporte: "2018-09-01-preview".
webhookUrl

string

minLength: 1

A URL do webhook usada para solicitações de alocação.

DeviceCapabilities

Objeto

Funcionalidades do dispositivo.

Nome Tipo Valor padrão Description
iotEdge

boolean

False

Se definido como true, esse dispositivo é um dispositivo IoTEdge.

DeviceRegistrationState

Objeto

Estado do registro do dispositivo.

Nome Tipo Description
assignedHub

string

Atribuído ao Hub IoT do Azure.
createdDateTimeUtc

string (date-time)

Hora de criação do registro (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)

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

object

registrationId

string

Essa ID é usada para identificar exclusivamente um registro de dispositivo de um registro. Uma cadeia de caracteres que não diferencia maiúsculas de minúsculas (até 128 caracteres de comprimento) de caracteres alfanuméricos mais determinados caracteres especiais: . _ -. Nenhum caractere especial permitido no início ou no final.
status enum:
  • assigned
  • assigning
  • disabled
  • failed
  • unassigned

Status do registro.
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 do dispositivo foram preenchidos do estado inicial armazenado no registro. Os dados do dispositivo foram removidos do hub IoT atribuído anteriormente, 'reprovisionedToInitialAssignment': o dispositivo foi provisionado novamente para um hub IoT atribuído anteriormente.

IndividualEnrollment

Objeto

O registro do dispositivo.

Nome Tipo Valor padrão Description
allocationPolicy enum:
  • custom
  • geoLatency
  • hashed
  • static

A política de alocação desse recurso. Essa política substitui a política de alocação no nível do locatário para esse grupo de registro ou registro individual. Os valores possíveis incluem 'hashed': Os hubs IoT vinculados têm igual probabilidade de ter dispositivos provisionados para eles, 'geoLatency': os dispositivos são provisionados para um hub IoT com a menor latência para o dispositivo. Se vários hubs IoT vinculados fornecerem a mesma latência mais baixa, o serviço de provisionamento hashes dispositivos entre esses hubs, 'estático': especificação do hub IoT desejado na lista de registro tem prioridade sobre a política de alocação no nível do serviço, 'personalizado': os dispositivos são provisionados para um hub IoT com base em sua própria lógica personalizada. O serviço de provisionamento passa informações sobre o dispositivo para a lógica e a lógica retorna o hub IoT desejado, bem como a configuração inicial desejada. É recomendável usar o Azure Functions para hospedar sua lógica.
attestation

AttestationMechanism

Mecanismo de atestado para individualEnrollment, bem como enrollmentGroup.
capabilities

DeviceCapabilities

Funcionalidades do dispositivo.
createdDateTimeUtc

string (date-time)

O DateTime em que este recurso foi criado.
customAllocationDefinition

CustomAllocationDefinition

Isso informa ao DPS qual webhook chamar ao usar a alocação personalizada.
deviceId

string

ID do dispositivo do Hub IoT desejado (opcional).
etag

string

A marca de entidade associada ao recurso.
initialTwin

InitialTwin

Dispositivo gêmeo inicial. Contém um subconjunto das propriedades do Gêmeo.
iotHubHostName

string

O nome do host do Hub Iot.
iotHubs

string[]

A lista de nomes de host do Hub IoT aos quais os dispositivos neste recurso podem ser alocados. Deve ser um subconjunto da lista de nível de locatário de hubs IoT.
lastUpdatedDateTimeUtc

string (date-time)

O DateTime em que este recurso foi atualizado pela última vez.
optionalDeviceInformation

TwinCollection

Representa uma coleção de propriedades em um gêmeo
provisioningStatus enum:
  • disabled
  • enabled
enabled

O status de provisionamento.
registrationId

string

minLength: 1

Essa ID é usada para identificar exclusivamente um registro de dispositivo de um registro. Uma cadeia de caracteres que não diferencia maiúsculas de minúsculas (até 128 caracteres de comprimento) de caracteres alfanuméricos mais determinados caracteres especiais: . _ -. Nenhum caractere especial permitido no início ou no final.
registrationState

DeviceRegistrationState

Estado do registro do dispositivo.
reprovisionPolicy

ReprovisionPolicy

O comportamento do serviço quando um dispositivo é provisionado novamente para um hub IoT.

InitialTwin

Objeto

Dispositivo gêmeo inicial. Contém um subconjunto das propriedades do Gêmeo.

Nome Tipo Description
properties

InitialTwinProperties

Representa as propriedades iniciais que serão definidas no dispositivo gêmeo.
tags

TwinCollection

Representa uma coleção de propriedades em um gêmeo

InitialTwinProperties

Objeto

Representa as propriedades iniciais que serão definidas no dispositivo gêmeo.

Nome Tipo Description
desired

TwinCollection

Representa uma coleção de propriedades em um gêmeo

Metadata

Objeto

Metadados para o TwinCollection

Nome Tipo Description
lastUpdated

string (date-time)

Última vez que o TwinCollection foi atualizado
lastUpdatedVersion

integer (int64)

Isso é nulo para metadados de propriedades relatadas e não é nulo para metadados de propriedades desejadas.

ProvisioningServiceErrorDetails

Objeto

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

Nome Tipo Description
errorCode

integer (int32)

info

object

message

string

timestampUtc

string (date-time)

trackingId

string

QuerySpecification

Objeto
Nome Tipo Description
query

string

ReprovisionPolicy

Objeto

O comportamento do serviço quando um dispositivo é provisionado novamente para um hub IoT.

Nome Tipo Valor padrão Description
migrateDeviceData

boolean

True

Quando definido como true (padrão), o Serviço de Provisionamento de Dispositivos migrará os dados do dispositivo (gêmeo, funcionalidades do dispositivo e ID do dispositivo) de um hub IoT para outro durante uma atualização de atribuição do hub IoT. Se definido como false, o Serviço de Provisionamento de Dispositivos redefinirá os dados do dispositivo para a configuração inicial desejada armazenada na lista de registro correspondente.
updateHubAssignment

boolean

True

Quando definido como true (padrão), o Serviço de Provisionamento de Dispositivos avaliará a atribuição do Hub IoT do dispositivo e a atualizará se necessário para solicitações de provisionamento além da primeira de um determinado dispositivo. Se definido como false, o dispositivo permanecerá atribuído ao hub IoT atual.

SymmetricKeyAttestation

Objeto

Atestado via SymmetricKey.

Nome Tipo Description
primaryKey

string

Chave simétrica primária.
secondaryKey

string

Chave simétrica secundária.

TpmAttestation

Objeto

Atestado via TPM.

Nome Tipo Description
endorsementKey

string

storageRootKey

string

TwinCollection

Objeto

Representa uma coleção de propriedades em um gêmeo

Nome Tipo Description
count

integer

Número de propriedades no TwinCollection
metadata

Metadata

Metadados para o TwinCollection
version

integer (int64)

Versão do TwinCollection

X509Attestation

Objeto

Atestado via X509.

Nome Tipo Description
caReferences

X509CAReferences

Referências de AC primária e secundária.
clientCertificates

X509Certificates

Certificados primários e secundários
signingCertificates

X509Certificates

Certificados primários e secundários

X509CAReferences

Objeto

Referências de AC primária e secundária.

Nome Tipo Description
primary

string

secondary

string

X509CertificateInfo

Objeto

Informações do certificado X509.

Nome Tipo Description
issuerName

string

notAfterUtc

string (date-time)

notBeforeUtc

string (date-time)

serialNumber

string

sha1Thumbprint

string

sha256Thumbprint

string

subjectName

string

version

integer (int32)

X509Certificates

Objeto

Certificados primários e secundários

Nome Tipo Description
primary

X509CertificateWithInfo

Informações de certificado e certificado
secondary

X509CertificateWithInfo

Informações de certificado e certificado

X509CertificateWithInfo

Objeto

Informações de certificado e certificado

Nome Tipo Description
certificate

string

info

X509CertificateInfo

Informações do certificado X509.