Partilhar via

Individual Enrollment - Create Or Update

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

Create ou atualizar um registo de inscrição de dispositivos.

PUT https://your-dps.azure-devices-provisioning.net/enrollments/{id}?api-version=2021-10-01

Parâmetros do URI

Name Em Necessário Tipo Description
id
 path True

string

Este ID é utilizado para identificar exclusivamente um registo de dispositivo de uma inscrição. Uma cadeia não sensível a maiúsculas e minúsculas (até 128 carateres) de carateres alfanuméricos e determinados carateres especiais: . _ -. Não são permitidos carateres especiais no início ou no fim.
api-version
 query True

string

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

Cabeçalho do Pedido

Name Necessário Tipo Description
If-Match

string

A ETag do registo de inscrição.

Corpo do Pedido

Name Necessário Tipo Description
attestation True

AttestationMechanism

Mecanismo de atestado para individualEnrollment, bem como enrollmentGroup.
registrationId True

string

Este ID é utilizado para identificar exclusivamente um registo de um dispositivo de uma inscrição. Uma cadeia não sensível a maiúsculas e minúsculas (até 128 carateres) de carateres alfanuméricos e determinados carateres especiais: . _ -. Não são permitidos carateres especiais no início ou no fim.
allocationPolicy enum:
  • hashed
  • geoLatency
  • static
  • custom

A política de alocação deste recurso. Esta política substitui a política de alocação ao nível do inquilino para este grupo de inscrição ou inscrição individual. Os valores possíveis incluem "hashed": É igualmente provável que os hubs IoT ligados tenham dispositivos aprovisionados, "geoLatency": os dispositivos são aprovisionados num hub IoT com a menor latência para o dispositivo. Se vários hubs IoT ligados fornecerem a mesma latência mais baixa, o serviço de aprovisionamento hashes dispositivos nesses hubs, "estático": a especificação do hub IoT pretendido na lista de inscrição tem prioridade sobre a política de alocação ao nível do serviço, "personalizada": os dispositivos são aprovisionados num hub IoT com base na sua própria lógica personalizada. O serviço de aprovisionamento transmite informações sobre o dispositivo para a lógica e a lógica devolve o hub IoT pretendido, bem como a configuração inicial pretendida. Recomendamos que utilize Funções do Azure para alojar a sua lógica.
capabilities

DeviceCapabilities

Capacidades do dispositivo.
customAllocationDefinition

CustomAllocationDefinition

Isto indica ao DPS qual o webhook a chamar ao utilizar a alocação personalizada.
deviceId

string

ID de dispositivo Hub IoT pretendido (opcional).
etag

string

A etiqueta de entidade associada ao recurso.
initialTwin

InitialTwin

Dispositivo duplo inicial. Contém um subconjunto das propriedades do Twin.
iotHubHostName

string

O nome do anfitrião do Hub Iot.
iotHubs

string[]

A lista de Hub IoT nomes de anfitrião aos quais os dispositivos neste recurso podem ser alocados. Tem de ser um subconjunto da lista ao nível do inquilino dos hubs IoT.
optionalDeviceInformation

TwinCollection

Representa uma coleção de propriedades num Duplo
provisioningStatus enum:
  • enabled
  • disabled

O estado de aprovisionamento.
registrationState

DeviceRegistrationState

Estado de registo do dispositivo.
reprovisionPolicy

ReprovisionPolicy

O comportamento do serviço quando um dispositivo é aprovisionado novamente num hub IoT.

Respostas

Name Tipo Description
200 OK

IndividualEnrollment

Com êxito
Other Status Codes

ProvisioningServiceErrorDetails

Resposta a erros

Cabeçalhos

x-ms-error-code: string

Definições

Name Description
AttestationMechanism

Mecanismo de atestado para individualEnrollment, bem como enrollmentGroup.
CustomAllocationDefinition

Isto indica ao DPS que webhook deve chamar ao utilizar a alocação personalizada.
DeviceCapabilities

Capacidades do dispositivo.
DeviceRegistrationState

Estado de registo do dispositivo.
IndividualEnrollment

O registo de inscrição de dispositivos.
InitialTwin

Dispositivo duplo inicial. Contém um subconjunto das propriedades do Twin.
InitialTwinProperties

Representa as propriedades iniciais que serão definidas no dispositivo duplo.
Metadata

Metadados da TwinCollection
ProvisioningServiceErrorDetails

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

O comportamento do serviço quando um dispositivo é aprovisionado novamente num hub IoT.
SymmetricKeyAttestation

Atestado através de SymmetricKey.
TpmAttestation

Atestado através do TPM.
TwinCollection

Representa uma coleção de propriedades num Duplo
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 de certificado e certificado

AttestationMechanism

Mecanismo de atestado para individualEnrollment, bem como enrollmentGroup.

Name Tipo Description
symmetricKey

SymmetricKeyAttestation

Atestado através de SymmetricKey.
tpm

TpmAttestation

Atestado através do TPM.
type enum:
  • none
  • symmetricKey
  • tpm
  • x509

Tipo de Atestado.
x509

X509Attestation

Atestado via X509.

CustomAllocationDefinition

Isto indica ao DPS que webhook deve chamar ao utilizar a alocação personalizada.

Name Tipo Description
apiVersion

string

A versão da API dos tipos de serviço de aprovisionamento (como IndividualEnrollment) enviada no pedido de alocação personalizada. Versão mínima suportada: "2018-09-01-preview".
webhookUrl

string

O URL do webhook utilizado para pedidos de alocação.

DeviceCapabilities

Capacidades do dispositivo.

Name Tipo Default value Description
iotEdge

boolean

False

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

DeviceRegistrationState

Estado de registo do dispositivo.

Name Tipo Description
assignedHub

string

Hub IoT do Azure atribuído.
createdDateTimeUtc

string

Data de criação de registo (em UTC).
deviceId

string

ID do dispositivo.
errorCode

integer

Código de erro.
errorMessage

string

Mensagem de erro.
etag

string

A etiqueta de entidade associada ao recurso.
lastUpdatedDateTimeUtc

string

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

object

registrationId

string

Este ID é utilizado para identificar exclusivamente um registo de um dispositivo de uma inscrição. Uma cadeia não sensível a maiúsculas e minúsculas (até 128 carateres) de carateres alfanuméricos e determinados carateres especiais: . _ -. Não são permitidos carateres especiais no início ou no fim.
status enum:
  • assigned
  • assigning
  • disabled
  • failed
  • unassigned

Estado 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 os dados do dispositivo foram migrados do hub IoT anteriormente atribuído. Os dados do dispositivo foram removidos do hub IoT anteriormente atribuído, "deviceDataReset": o dispositivo foi atribuído a um hub IoT diferente e os respetivos dados do dispositivo foram preenchidos a partir do estado inicial armazenado na inscrição. Os dados do dispositivo foram removidos do hub IoT anteriormente atribuído, "reprovisionedToInitialAssignment": O dispositivo foi aprovisionado novamente num hub IoT atribuído anteriormente.

IndividualEnrollment

O registo de inscrição de dispositivos.

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

A política de alocação deste recurso. Esta política substitui a política de alocação ao nível do inquilino para este grupo de inscrição ou inscrição individual. Os valores possíveis incluem "hashed": os hubs IoT ligados são igualmente propensos a ter dispositivos aprovisionados, "geoLatency": os dispositivos são aprovisionados num 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 aprovisionamento hashes dispositivos nesses hubs, "estático": a especificação do hub IoT pretendido na lista de inscrição tem prioridade sobre a política de alocação ao nível do serviço, "personalizada": os dispositivos são aprovisionados num hub IoT com base na sua própria lógica personalizada. O serviço de aprovisionamento transmite informações sobre o dispositivo para a lógica e a lógica devolve o hub IoT pretendido, bem como a configuração inicial pretendida. Recomendamos que utilize Funções do Azure para alojar a sua lógica.
attestation

AttestationMechanism

Mecanismo de atestado para individualEnrollment, bem como enrollmentGroup.
capabilities

DeviceCapabilities

Capacidades do dispositivo.
createdDateTimeUtc

string

O DateTime que este recurso foi criado.
customAllocationDefinition

CustomAllocationDefinition

Isto indica ao DPS que webhook deve chamar ao utilizar a alocação personalizada.
deviceId

string

ID de dispositivo Hub IoT pretendido (opcional).
etag

string

A etiqueta de entidade associada ao recurso.
initialTwin

InitialTwin

Dispositivo duplo inicial. Contém um subconjunto das propriedades do Twin.
iotHubHostName

string

O nome do anfitrião do Hub Iot.
iotHubs

string[]

A lista de Hub IoT nomes de anfitrião aos quais os dispositivos neste recurso podem ser atribuídos. Tem de ser um subconjunto da lista ao nível do inquilino dos hubs IoT.
lastUpdatedDateTimeUtc

string

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

TwinCollection

Representa uma coleção de propriedades num Duplo
provisioningStatus enum:
  • disabled
  • enabled
enabled

O estado de aprovisionamento.
registrationId

string

Este ID é utilizado para identificar exclusivamente um registo de um dispositivo de uma inscrição. Uma cadeia não sensível a maiúsculas e minúsculas (até 128 carateres) de carateres alfanuméricos e determinados carateres especiais: . _ -. Não são permitidos carateres especiais no início ou no fim.
registrationState

DeviceRegistrationState

Estado de registo do dispositivo.
reprovisionPolicy

ReprovisionPolicy

O comportamento do serviço quando um dispositivo é aprovisionado novamente num hub IoT.

InitialTwin

Dispositivo duplo inicial. Contém um subconjunto das propriedades do Twin.

Name Tipo Description
properties

InitialTwinProperties

Representa as propriedades iniciais que serão definidas no dispositivo duplo.
tags

TwinCollection

Representa uma coleção de propriedades num Duplo

InitialTwinProperties

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

Name Tipo Description
desired

TwinCollection

Representa uma coleção de propriedades num Duplo

Metadata

Metadados da TwinCollection

Name Tipo Description
lastUpdated

string

Última vez que o TwinCollection foi atualizado
lastUpdatedVersion

integer

Isto é nulo para metadados de propriedades reportados e não é nulo para metadados de propriedades pretendidos.

ProvisioningServiceErrorDetails

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

Name Tipo Description
errorCode

integer

info

object

message

string

timestampUtc

string

trackingId

string

ReprovisionPolicy

O comportamento do serviço quando um dispositivo é aprovisionado novamente num hub IoT.

Name Tipo Default value Description
migrateDeviceData

boolean

True

Quando definido como verdadeiro (predefinição), o Serviço de Aprovisionamento de Dispositivos migrará os dados do dispositivo (duplo, capacidades do dispositivo e ID do dispositivo) de um hub IoT para outro durante uma atualização de atribuição do hub IoT. Se estiver definido como falso, o Serviço de Aprovisionamento de Dispositivos irá repor os dados do dispositivo para a configuração pretendida inicial armazenada na lista de inscrição correspondente.
updateHubAssignment

boolean

True

Quando definido como verdadeiro (predefinição), o Serviço de Aprovisionamento de Dispositivos avaliará a atribuição de Hub IoT do dispositivo e atualizá-la-á se necessário para quaisquer pedidos de aprovisionamento para além do primeiro de um determinado dispositivo. Se estiver definido como falso, o dispositivo permanecerá atribuído ao hub IoT atual.

SymmetricKeyAttestation

Atestado através de SymmetricKey.

Name Tipo Description
primaryKey

string

Chave simétrica primária.
secondaryKey

string

Chave simétrica secundária.

TpmAttestation

Atestado através do TPM.

Name Tipo Description
endorsementKey

string

storageRootKey

string

TwinCollection

Representa uma coleção de propriedades num Duplo

Name Tipo Description
count

integer

Número de propriedades no TwinCollection
metadata

Metadata

Metadados da TwinCollection
version

integer

Versão do TwinCollection

X509Attestation

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

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

Name Tipo Description
primary

string

secondary

string

X509CertificateInfo

Informações do certificado X509.

Name 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

Name 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

Name Tipo Description
certificate

string

info

X509CertificateInfo

Informações do certificado X509.