Enrollment Group - Query

  • Referência
Service:
IoT Hub Device Provisioning Service
API Version:
2021-10-01

Consulte os grupos de registro de dispositivo.

POST https://your-dps.azure-devices-provisioning.net/enrollmentGroups/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

EnrollmentGroup[]

Êxito

Headers

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

ProvisioningServiceErrorDetails

Resposta de erro

Headers

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.
EnrollmentGroup

Registro de grupo de registro.
InitialTwin

Dispositivo gêmeo inicial. Contém um subconjunto das propriedades de Twin.
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 dentro de 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

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

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

Nome Tipo Description
apiVersion

string

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

string

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

DeviceCapabilities

Funcionalidades do dispositivo.

Nome Tipo Valor padrão Description
iotEdge

boolean

False

Se definido como true, este dispositivo será um dispositivo IoTEdge.

EnrollmentGroup

Registro de grupo de registro.

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 registro individual ou grupo de registro. Os valores possíveis incluem 'hash': hubs IoT vinculados são igualmente propensos a 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 nesses hubs, 'estático': especificação do hub IoT desejado na lista de registros tem prioridade sobre a política de alocação no nível do serviço, 'custom': 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 Azure Functions para hospedar sua lógica.
attestation

AttestationMechanism

Mecanismo de atestado para individualEnrollment, bem como enrollmentGroup.
capabilities

DeviceCapabilities

Funcionalidades do dispositivo.
createdDateTimeUtc

string

O DateTime em que esse recurso foi criado.
customAllocationDefinition

CustomAllocationDefinition

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

string

ID do Grupo de Registro.
etag

string

A marca de entidade associada ao recurso.
initialTwin

InitialTwin

Dispositivo gêmeo inicial. Contém um subconjunto das propriedades de Twin.
iotHubHostName

string

O nome do host do Hub IoT.
iotHubs

string[]

A lista de Hub IoT nomes de host aos dispositivos nesse recurso pode ser alocada. Deve ser um subconjunto da lista de nível de locatário de hubs IoT.
lastUpdatedDateTimeUtc

string

O DateTime em que este recurso foi atualizado pela última vez.
provisioningStatus enum:
  • disabled
  • enabled
enabled

O status de provisionamento.
reprovisionPolicy

ReprovisionPolicy

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

InitialTwin

Dispositivo gêmeo inicial. Contém um subconjunto das propriedades de Twin.

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 dentro de um gêmeo

InitialTwinProperties

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

Nome Tipo Description
desired

TwinCollection

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

Metadata

Metadados para o TwinCollection

Nome Tipo Description
lastUpdated

string

Última vez que o TwinCollection foi atualizado
lastUpdatedVersion

integer

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

ProvisioningServiceErrorDetails

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

Nome Tipo Description
errorCode

integer

info

object

message

string

timestampUtc

string

trackingId

string

QuerySpecification

Nome Tipo Description
query

string

ReprovisionPolicy

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 registros correspondente.
updateHubAssignment

boolean

True

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

SymmetricKeyAttestation

Atestado via SymmetricKey.

Nome Tipo Description
primaryKey

string

Chave simétrica primária.
secondaryKey

string

Chave simétrica secundária.

TpmAttestation

Atestado via TPM.

Nome Tipo Description
endorsementKey

string

storageRootKey

string

TwinCollection

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

Nome Tipo Description
count

integer

Número de propriedades no TwinCollection
metadata

Metadata

Metadados para o TwinCollection
version

integer

Versão do TwinCollection

X509Attestation

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

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

Nome Tipo Description
primary

string

secondary

string

X509CertificateInfo

Informações do certificado X509.

Nome Tipo Description
issuerName

string

notAfterUtc

string

notBeforeUtc

string

serialNumber

string

sha1Thumbprint

string

sha256Thumbprint

string

subjectName

string

version

integer

X509Certificates

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

Informações de certificado e certificado

Nome Tipo Description
certificate

string

info

X509CertificateInfo

Informações do certificado X509.