Enrollment Group - Get

Arranja um grupo de inscrição de dispositivos.

GET https://your-dps.azure-devices-provisioning.net/enrollmentGroups/{id}?api-version=2021-06-01

Parâmetros do URI

Name In Required Type Description
id
path True
  • string

Identificação do grupo de inscrições.

api-version
query True
  • string

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

Respostas

Name Type Description
200 OK

Com êxito

Other Status Codes

Resposta de erro

Definições

AttestationMechanism

Mecanismo de atestação individualEnrollment, bem como grupo de inscrições.

CustomAllocationDefinition

Isto diz ao DPS a que webhook para ligar quando se utiliza alocação personalizada.

DeviceCapabilities

Capacidades do dispositivo.

EnrollmentGroup

Registo do grupo de inscrições.

InitialTwin

Dispositivo inicial twin. Contém um subconjunto das propriedades de Twin.

InitialTwinProperties

Representa as propriedades iniciais que serão definidas no twin do dispositivo.

Metadata

Metadados para a TwinCollection

ProvisioningServiceErrorDetails

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

ReprovisionPolicy

O comportamento do serviço quando um dispositivo é re-a provisionado 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 CA primárias e secundárias.

X509CertificateInfo

Informação de certificado X509.

X509Certificates

Certificados primários e secundários

X509CertificateWithInfo

Informações de Certificado e Certificado

AttestationMechanism

Mecanismo de atestação individualEnrollment, bem como grupo de inscrições.

Name Type Description
symmetricKey

Método de atestado chave simétrica.

tpm

Método de atestação TPM.

type enum:
  • none
  • symmetricKey
  • tpm
  • x509

Tipo de Attestation.

x509

Método de atestado X509.

CustomAllocationDefinition

Isto diz ao DPS a que webhook para ligar quando se utiliza alocação personalizada.

Name Type Description
apiVersion
  • string

A versão API dos tipos de serviços de fornecimento (como IndividualEnrollment) enviada no pedido de atribuição personalizada. Versão mínima suportada: "2018-09-01-pré-visualização".

webhookUrl
  • string

O URL webhook usado para pedidos de atribuição.

DeviceCapabilities

Capacidades do dispositivo.

Name Type Default Value Description
iotEdge
  • boolean
false

Se for definido como verdadeiro, este dispositivo é um dispositivo IoTEdge.

EnrollmentGroup

Registo do grupo de inscrições.

Name Type Default Value Description
allocationPolicy enum:
  • custom
  • geoLatency
  • hashed
  • static

A política de atribuição deste recurso. Esta política substitui a política de atribuição de nível de inquilino para este grupo individual de inscrição ou inscrição. Os valores possíveis incluem 'hashed': Os hubs IoT ligados são igualmente propensos a ter dispositivos a quem forem ateados, 'geoLatency': Os dispositivos são a provisionados a um hub IoT com a latência mais baixa do dispositivo. Se vários hubs IoT ligados fornecerem a mesma latência mais baixa, o serviço de fornecimento hashes dispositivos através desses centros, 'estático' : A especificação do centro IoT desejado na lista de inscrições tem prioridade sobre a política de atribuição ao nível do serviço, 'custom': Os dispositivos são alotados a um hub IoT baseado na sua própria lógica personalizada. O serviço de fornecimento transmite informação sobre o dispositivo à lógica, e a lógica devolve o hub IoT desejado, bem como a configuração inicial desejada. Recomendamos a utilização de Funções do Azure para hospedar a sua lógica.

attestation

Método de atestado utilizado pelo dispositivo.

capabilities

Capacidades do dispositivo.

createdDateTimeUtc
  • string

O DateTime este recurso foi criado.

customAllocationDefinition

Isto diz ao DPS a que webhook para ligar quando se utiliza alocação personalizada.

enrollmentGroupId
  • string

ID do Grupo de Inscrição.

etag
  • string

A etiqueta de entidade associada ao recurso.

initialTwin

Dispositivo inicial twin.

iotHubHostName
  • string

O nome de anfitrião do Iot Hub.

iotHubs
  • string[]

A lista de Hub IoT os nomes dos dispositivos neste recurso podem ser atribuídos. Deve ser um subconjunto de nível de inquilino de centros IoT.

lastUpdatedDateTimeUtc
  • string

O DateTime este recurso foi atualizado pela última vez.

provisioningStatus enum:
  • disabled
  • enabled
enabled

O estado de provisionamento.

reprovisionPolicy

O comportamento quando um dispositivo é re-a provisionado para um hub IoT.

InitialTwin

Dispositivo inicial twin. Contém um subconjunto das propriedades de Twin.

Name Type Description
properties

Propriedades duplas desejadas.

tags

Etiquetas gémeas.

InitialTwinProperties

Representa as propriedades iniciais que serão definidas no twin do dispositivo.

Name Type Description
desired

Obtém e define as propriedades desejadas initialTwin.

Metadata

Metadados para a TwinCollection

Name Type Description
lastUpdated
  • string

A última vez que a TwinCollection foi atualizada

lastUpdatedVersion
  • integer

Isto é nulo para metadados de propriedades reportadas e não é nulo para os metadados de propriedades desejadas.

ProvisioningServiceErrorDetails

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

Name Type Description
errorCode
  • integer
info
  • object
message
  • string
timestampUtc
  • string
trackingId
  • string

ReprovisionPolicy

O comportamento do serviço quando um dispositivo é re-a provisionado para um hub IoT.

Name Type Default Value Description
migrateDeviceData
  • boolean
true

Quando definido como verdadeiro (padrão), o Serviço de Provisionamento de Dispositivos migrará os dados do dispositivo (twin, capacidades de dispositivo e ID do dispositivo) de um hub IoT para outro durante uma atualização de atribuição de ioT. Se for definido como falso, o Serviço de Provisionamento de Dispositivos redefinirá os dados do dispositivo para a configuração inicial desejada armazenada na lista de matrículas correspondente.

updateHubAssignment
  • boolean
true

Quando definido como verdadeiro (predefinido), o Serviço de Provisionamento de Dispositivos avaliará a Hub IoT atribuição do dispositivo e actualizará-o se necessário para quaisquer pedidos de provisionamento para além do primeiro de um determinado dispositivo. Se for definido como falso, o dispositivo permanecerá atribuído ao seu atual hub IoT.

SymmetricKeyAttestation

Atestado via SymmetricKey.

Name Type Description
primaryKey
  • string

Chave simétrica primária.

secondaryKey
  • string

Chave simétrica secundária.

TpmAttestation

Atestado via TPM.

Name Type Description
endorsementKey
  • string
storageRootKey
  • string

TwinCollection

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

Name Type Description
count
  • integer

Número de propriedades na TwinCollection

metadata

Metadados para a TwinCollection

version
  • integer

Versão da TwinCollection

X509Attestation

Atestado via X509.

Name Type Description
caReferences

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

clientCertificates

Certificados primários e secundários

signingCertificates

Certificados primários e secundários

X509CAReferences

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

Name Type Description
primary
  • string
secondary
  • string

X509CertificateInfo

Informação de certificado X509.

Name Type Description
issuerName
  • string
notAfterUtc
  • string
notBeforeUtc
  • string
serialNumber
  • string
sha1Thumbprint
  • string
sha256Thumbprint
  • string
subjectName
  • string
version
  • integer

X509Certificates

Certificados primários e secundários

Name Type Description
primary

Informações de Certificado e Certificado

secondary

Informações de Certificado e Certificado

X509CertificateWithInfo

Informações de Certificado e Certificado

Name Type Description
certificate
  • string
info

Informação de certificado X509.