Partilhar via

Enrollment Group - Query

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

Consulte os grupos de inscrição de dispositivos.

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

Parâmetros do URI

Name Em Necessário Tipo Description
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

Corpo do Pedido

Name Necessário Tipo Description
query True

string

Respostas

Name Tipo Description
200 OK

EnrollmentGroup[]

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
AttestationMechanism

Mecanismo de atestado para inscrição individual, bem como inscrição em grupo.
CustomAllocationDefinition

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

Capacidades do dispositivo.
EnrollmentGroup

Registo do grupo de inscrição.
InitialTwin

Gêmeo inicial do dispositivo. Contém um subconjunto das propriedades de Twin.
InitialTwinProperties

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

Metadados para a 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 é reprovisionado para um hub IoT.
SymmetricKeyAttestation

Atestado via SymmetricKey.
TpmAttestation

Atestado via TPM.
TwinCollection

Representa uma coleção de propriedades dentro de um Twin
X509Attestation

Atestado via X509.
X509CAReferences

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

Informações do certificado X509.
X509Certificates

Certificados primários e secundários
X509CertificateWithInfo

Informações do certificado e do certificado

AttestationMechanism

Object

Mecanismo de atestado para inscrição individual, bem como inscrição em grupo.

Name 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

Object

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

Name Tipo Description
apiVersion

string

minLength: 1

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 suportada: "2018-09-01-preview".
webhookUrl

string

minLength: 1

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

DeviceCapabilities

Object

Capacidades do dispositivo.

Name Tipo Default value Description
iotEdge

boolean

False

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

EnrollmentGroup

Object

Registo do grupo de inscrição.

Name Tipo Default value Description
allocationPolicy enum:
  • custom
  • geoLatency
  • hashed
  • static

A política de alocação deste recurso. Essa política substitui a política de alocação em nível de locatário para esse registro individual ou grupo de registros. Os valores possíveis incluem 'hashed': hubs IoT vinculados têm igualmente 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 hashará dispositivos nesses hubs, 'estático' : A especificação do hub IoT desejado na lista de inscrição terá prioridade sobre a política de alocação de nível de serviço, 'personalizada': 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. Recomendamos usar o Azure Functions para hospedar sua lógica.
attestation

AttestationMechanism

Mecanismo de atestado para inscrição individual, bem como inscrição em grupo.
capabilities

DeviceCapabilities

Capacidades do dispositivo.
createdDateTimeUtc

string (date-time)

O DateTime este recurso foi criado.
customAllocationDefinition

CustomAllocationDefinition

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

string

minLength: 1

ID do Grupo de Inscrição.
etag

string

A marca de entidade associada ao recurso.
initialTwin

InitialTwin

Gêmeo inicial do dispositivo. Contém um subconjunto das propriedades de Twin.
iotHubHostName

string

O nome do host do Iot Hub.
iotHubs

string[]

A lista de nomes de host do Hub IoT para os quais o(s) dispositivo(s) neste recurso podem ser alocados. Deve ser um subconjunto da lista de hubs IoT em nível de locatário.
lastUpdatedDateTimeUtc

string (date-time)

O DateTime deste 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 é reprovisionado para um hub IoT.

InitialTwin

Object

Gêmeo inicial do dispositivo. Contém um subconjunto das propriedades de Twin.

Name Tipo Description
properties

InitialTwinProperties

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

TwinCollection

Representa uma coleção de propriedades dentro de um Twin

InitialTwinProperties

Object

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

Name Tipo Description
desired

TwinCollection

Representa uma coleção de propriedades dentro de um Twin

Metadata

Object

Metadados para a TwinCollection

Name Tipo Description
lastUpdated

string (date-time)

Última vez que a TwinCollection foi atualizada
lastUpdatedVersion

integer (int64)

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

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

QuerySpecification

Object
Name Tipo Description
query

string

ReprovisionPolicy

Object

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

Name Tipo Default value Description
migrateDeviceData

boolean

True

Quando definido como true (padrão), o Serviço de Provisionamento de Dispositivo migrará os dados do dispositivo (gêmeo, recursos 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 Dispositivo 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 Dispositivo avaliará a atribuição do Hub IoT do dispositivo e a atualizará, se necessário, para quaisquer solicitações de provisionamento além da primeira de um determinado dispositivo. Se definido como false, o dispositivo permanecerá atribuído ao seu hub IoT atual.

SymmetricKeyAttestation

Object

Atestado via SymmetricKey.

Name Tipo Description
primaryKey

string

Chave simétrica primária.
secondaryKey

string

Chave simétrica secundária.

TpmAttestation

Object

Atestado via TPM.

Name Tipo Description
endorsementKey

string

storageRootKey

string

TwinCollection

Object

Representa uma coleção de propriedades dentro de um Twin

Name Tipo Description
count

integer

Número de propriedades na TwinCollection
metadata

Metadata

Metadados para a TwinCollection
version

integer (int64)

Versão da TwinCollection

X509Attestation

Object

Atestado via X509.

Name Tipo Description
caReferences

X509CAReferences

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

X509Certificates

Certificados primários e secundários
signingCertificates

X509Certificates

Certificados primários e secundários

X509CAReferences

Object

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

Name Tipo Description
primary

string

secondary

string

X509CertificateInfo

Object

Informações do certificado X509.

Name Tipo Description
issuerName

string

notAfterUtc

string (date-time)

notBeforeUtc

string (date-time)

serialNumber

string

sha1Thumbprint

string

sha256Thumbprint

string

subjectName

string

version

integer (int32)

X509Certificates

Object

Certificados primários e secundários

Name Tipo Description
primary

X509CertificateWithInfo

Informações do certificado e do certificado
secondary

X509CertificateWithInfo

Informações do certificado e do certificado

X509CertificateWithInfo

Object

Informações do certificado e do certificado

Name Tipo Description
certificate

string

info

X509CertificateInfo

Informações do certificado X509.