Individual Enrollment - Create Or Update
Create ou atualizar um registro de dispositivo.
PUT https://your-dps.azure-devices-provisioning.net/enrollments/{id}?api-version=2021-10-01
Parâmetros de URI
Nome | Em | Obrigatório | Tipo | Description |
---|---|---|---|---|
id
|
path | True |
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. |
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 |
---|---|---|---|
If-Match |
string |
A ETag do registro. |
Corpo da solicitação
Nome | Obrigatório | Tipo | Description |
---|---|---|---|
attestation | True |
Mecanismo de atestado para individualEnrollment, bem como enrollmentGroup. |
|
registrationId | True |
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. |
allocationPolicy |
enum:
|
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. |
|
capabilities |
Funcionalidades do dispositivo. |
||
customAllocationDefinition |
Isso informa ao DPS qual webhook chamar ao usar a alocação personalizada. |
||
deviceId |
string |
ID do dispositivo Hub IoT desejada (opcional). |
|
etag |
string |
A marca de entidade associada ao recurso. |
|
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. |
|
optionalDeviceInformation |
Representa uma coleção de propriedades em um gêmeo |
||
provisioningStatus |
enum:
|
O status de provisionamento. |
|
registrationState |
Estado de registro do dispositivo. |
||
reprovisionPolicy |
O comportamento do serviço quando um dispositivo é provisionado novamente para um hub IoT. |
Respostas
Nome | Tipo | Description |
---|---|---|
200 OK |
Êxito |
|
Other Status Codes |
Resposta de erro Cabeçalhos x-ms-error-code: string |
Definições
Nome | Description |
---|---|
Attestation |
Mecanismo de atestado para individualEnrollment, bem como enrollmentGroup. |
Custom |
Isso informa ao DPS qual webhook chamar ao usar a alocação personalizada. |
Device |
Funcionalidades do dispositivo. |
Device |
Estado de registro do dispositivo. |
Individual |
O registro do dispositivo. |
Initial |
Dispositivo gêmeo inicial. Contém um subconjunto das propriedades de Twin. |
Initial |
Representa as propriedades iniciais que serão definidas no dispositivo gêmeo. |
Metadata |
Metadados para o TwinCollection |
Provisioning |
Contém as propriedades de um erro retornado pelo Serviço de Provisionamento de Hub IoT do Azure. |
Reprovision |
O comportamento do serviço quando um dispositivo é provisionado novamente em um hub IoT. |
Symmetric |
Atestado via SymmetricKey. |
Tpm |
Atestado via TPM. |
Twin |
Representa uma coleção de propriedades em um gêmeo |
X509Attestation |
Atestado via X509. |
X509CAReferences |
Referências de AC primária e secundária. |
X509Certificate |
Informações do certificado X509. |
X509Certificates |
Certificados primários e secundários |
X509Certificate |
Informações de certificado e certificado |
AttestationMechanism
Mecanismo de atestado para individualEnrollment, bem como enrollmentGroup.
Nome | Tipo | Description |
---|---|---|
symmetricKey |
Atestado via SymmetricKey. |
|
tpm |
Atestado via TPM. |
|
type |
enum:
|
Tipo de atestado. |
x509 |
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, esse dispositivo será um dispositivo IoTEdge. |
DeviceRegistrationState
Estado de registro do dispositivo.
Nome | Tipo | Description |
---|---|---|
assignedHub |
string |
Atribuído Hub IoT do Azure. |
createdDateTimeUtc |
string |
Data de criação do registro (em UTC). |
deviceId |
string |
ID do Dispositivo. |
errorCode |
integer |
Código do erro. |
errorMessage |
string |
Mensagem de erro. |
etag |
string |
A marca de entidade associada ao recurso. |
lastUpdatedDateTimeUtc |
string |
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:
|
Status de registro. |
substatus |
enum:
|
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 de 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
O registro do dispositivo.
Nome | Tipo | Valor padrão | Description |
---|---|---|---|
allocationPolicy |
enum:
|
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 'hashed': hubs IoT vinculados têm igual probabilidade de ter dispositivos provisionados para eles, 'geoLatency': os dispositivos são provisionados em 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, '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 Azure Functions para hospedar sua lógica. |
|
attestation |
Mecanismo de atestado para individualEnrollment, bem como enrollmentGroup. |
||
capabilities |
Funcionalidades do dispositivo. |
||
createdDateTimeUtc |
string |
O DateTime em que esse recurso foi criado. |
|
customAllocationDefinition |
Isso informa ao DPS qual webhook chamar ao usar a alocação personalizada. |
||
deviceId |
string |
ID do dispositivo Hub IoT desejada (opcional). |
|
etag |
string |
A marca de entidade associada ao recurso. |
|
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 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 |
O DateTime em que esse recurso foi atualizado pela última vez. |
|
optionalDeviceInformation |
Representa uma coleção de propriedades em um gêmeo |
||
provisioningStatus |
enum:
|
enabled |
O status de provisionamento. |
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. |
|
registrationState |
Estado de registro do dispositivo. |
||
reprovisionPolicy |
O comportamento do serviço quando um dispositivo é provisionado novamente em um hub IoT. |
InitialTwin
Dispositivo gêmeo inicial. Contém um subconjunto das propriedades de Twin.
Nome | Tipo | Description |
---|---|---|
properties |
Representa as propriedades iniciais que serão definidas no dispositivo gêmeo. |
|
tags |
Representa uma coleção de propriedades em um gêmeo |
InitialTwinProperties
Representa as propriedades iniciais que serão definidas no dispositivo gêmeo.
Nome | Tipo | Description |
---|---|---|
desired |
Representa uma coleção de propriedades em 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 desejadas. |
ProvisioningServiceErrorDetails
Contém as propriedades de um erro retornado pelo Serviço de Provisionamento de Hub IoT do Azure.
Nome | Tipo | Description |
---|---|---|
errorCode |
integer |
|
info |
object |
|
message |
string |
|
timestampUtc |
string |
|
trackingId |
string |
ReprovisionPolicy
O comportamento do serviço quando um dispositivo é provisionado novamente em 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, recursos de 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 Dispositivo 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 em um gêmeo
Nome | Tipo | Description |
---|---|---|
count |
integer |
Número de propriedades no TwinCollection |
metadata |
Metadados para o TwinCollection |
|
version |
integer |
Versão do TwinCollection |
X509Attestation
Atestado via X509.
Nome | Tipo | Description |
---|---|---|
caReferences |
Referências de AC primária e secundária. |
|
clientCertificates |
Certificados primários e secundários |
|
signingCertificates |
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 |
Informações de certificado e certificado |
|
secondary |
Informações de certificado e certificado |
X509CertificateWithInfo
Informações de certificado e certificado
Nome | Tipo | Description |
---|---|---|
certificate |
string |
|
info |
Informações do certificado X509. |