Compartir a través de

Individual Enrollment - Create Or Update

Servicio:
IoT Hub Device Provisioning Service
Versión de la API:
2021-10-01

Cree o actualice un registro de inscripción de dispositivos.

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description
id
 path True

string

Este identificador se usa para identificar de forma única un registro de dispositivo de una inscripción. Cadena que no distingue mayúsculas de minúsculas (hasta 128 caracteres de largo) de caracteres alfanuméricos más determinados caracteres especiales: . _ -. No se permiten caracteres especiales al principio o al final.
api-version
 query True

string

Versión de la API que se va a usar para la solicitud. Entre las versiones admitidas se incluyen: 2021-10-01

Encabezado de la solicitud

Nombre Requerido Tipo Description
If-Match

string

ETag del registro de inscripción.

Cuerpo de la solicitud

Nombre Requerido Tipo Description
attestation True

AttestationMechanism

Mecanismo de atestación para individualEnrollment, así como enrollmentGroup.
registrationId True

string

minLength: 1

Este identificador se usa para identificar de forma única un registro de dispositivo de una inscripción. Cadena que no distingue mayúsculas de minúsculas (hasta 128 caracteres de largo) de caracteres alfanuméricos más determinados caracteres especiales: . _ -. No se permiten caracteres especiales al principio o al final.
allocationPolicy enum:
  • hashed
  • geoLatency
  • static
  • custom

Directiva de asignación de este recurso. Esta directiva invalida la directiva de asignación de nivel de inquilino para esta inscripción individual o grupo de inscripción. Entre los valores posibles se incluyen "hashed": es igualmente probable que los centros de IoT vinculados tengan dispositivos aprovisionados, "geoLatency": los dispositivos se aprovisionan en un centro de IoT con la latencia más baja para el dispositivo. Si varios centros de IoT vinculados proporcionarían la misma latencia más baja, los dispositivos hash del servicio de aprovisionamiento en esos centros, "estáticos": la especificación del centro de IoT deseado en la lista de inscripción tiene prioridad sobre la directiva de asignación de nivel de servicio, "personalizada": los dispositivos se aprovisionan en un centro de IoT basado en su propia lógica personalizada. El servicio de aprovisionamiento pasa información sobre el dispositivo a la lógica y la lógica devuelve el centro de IoT deseado, así como la configuración inicial deseada. Se recomienda usar Azure Functions para hospedar la lógica.
capabilities

DeviceCapabilities

Funcionalidades del dispositivo.
customAllocationDefinition

CustomAllocationDefinition

Esto indica a DPS a qué webhook llamar al usar la asignación personalizada.
deviceId

string

Id. de dispositivo de IoT Hub deseado (opcional).
etag

string

Etiqueta de entidad asociada al recurso.
initialTwin

InitialTwin

Dispositivo gemelo inicial. Contiene un subconjunto de las propiedades de Twin.
iotHubHostName

string

Nombre de host de IoT Hub.
iotHubs

string[]

La lista de nombres de host de IoT Hub a los que se pueden asignar los dispositivos de este recurso. Debe ser un subconjunto de la lista de nivel de inquilino de ioT Hubs.
optionalDeviceInformation

TwinCollection

Representa una colección de propiedades dentro de un gemelo.
provisioningStatus enum:
  • enabled
  • disabled

Estado de aprovisionamiento.
registrationState

DeviceRegistrationState

Estado de registro del dispositivo.
reprovisionPolicy

ReprovisionPolicy

El comportamiento del servicio cuando se vuelve a aprovisionar un dispositivo en un centro de IoT.

Respuestas

Nombre Tipo Description
200 OK

IndividualEnrollment

Éxito
Other Status Codes

ProvisioningServiceErrorDetails

Respuesta de error

Encabezados

x-ms-error-code: string

Definiciones

Nombre Description
AttestationMechanism

Mecanismo de atestación para individualEnrollment, así como enrollmentGroup.
CustomAllocationDefinition

Esto indica a DPS a qué webhook llamar al usar la asignación personalizada.
DeviceCapabilities

Funcionalidades del dispositivo.
DeviceRegistrationState

Estado de registro del dispositivo.
IndividualEnrollment

Registro de inscripción de dispositivos.
InitialTwin

Dispositivo gemelo inicial. Contiene un subconjunto de las propiedades de Twin.
InitialTwinProperties

Representa las propiedades iniciales que se establecerán en el dispositivo gemelo.
Metadata

Metadatos de TwinCollection
ProvisioningServiceErrorDetails

Contiene las propiedades de un error devuelto por el servicio de aprovisionamiento de Azure IoT Hub.
ReprovisionPolicy

El comportamiento del servicio cuando se vuelve a aprovisionar un dispositivo en un centro de IoT.
SymmetricKeyAttestation

Atestación a través de SymmetricKey.
TpmAttestation

Atestación a través de TPM.
TwinCollection

Representa una colección de propiedades dentro de un gemelo.
X509Attestation

Atestación a través de X509.
X509CAReferences

Referencias de entidad de certificación principal y secundaria.
X509CertificateInfo

Información del certificado X509.
X509Certificates

Certificados principales y secundarios
X509CertificateWithInfo

Información de certificado y certificado

AttestationMechanism

Object

Mecanismo de atestación para individualEnrollment, así como enrollmentGroup.

Nombre Tipo Description
symmetricKey

SymmetricKeyAttestation

Atestación a través de SymmetricKey.
tpm

TpmAttestation

Atestación a través de TPM.
type enum:
  • none
  • symmetricKey
  • tpm
  • x509

Tipo de atestación.
x509

X509Attestation

Atestación a través de X509.

CustomAllocationDefinition

Object

Esto indica a DPS a qué webhook llamar al usar la asignación personalizada.

Nombre Tipo Description
apiVersion

string

minLength: 1

La versión de API de los tipos de servicio de aprovisionamiento (como IndividualEnrollment) enviadas en la solicitud de asignación personalizada. Versión mínima admitida: "2018-09-01-preview".
webhookUrl

string

minLength: 1

Dirección URL del webhook que se usa para las solicitudes de asignación.

DeviceCapabilities

Object

Funcionalidades del dispositivo.

Nombre Tipo Valor predeterminado Description
iotEdge

boolean

False

Si se establece en true, este dispositivo es un dispositivo IoTEdge.

DeviceRegistrationState

Object

Estado de registro del dispositivo.

Nombre Tipo Description
assignedHub

string

Azure IoT Hub asignado.
createdDateTimeUtc

string (date-time)

Fecha y hora de creación del registro (en UTC).
deviceId

string

Id. de dispositivo.
errorCode

integer (int32)

Código de error.
errorMessage

string

Mensaje de error.
etag

string

Etiqueta de entidad asociada al recurso.
lastUpdatedDateTimeUtc

string (date-time)

Hora de fecha y hora actualizadas por última vez (en UTC).
payload

object

registrationId

string

Este identificador se usa para identificar de forma única un registro de dispositivo de una inscripción. Cadena que no distingue mayúsculas de minúsculas (hasta 128 caracteres de largo) de caracteres alfanuméricos más determinados caracteres especiales: . _ -. No se permiten caracteres especiales al principio o al final.
status enum:
  • assigned
  • assigning
  • disabled
  • failed
  • unassigned

Estado de inscripción.
substatus enum:
  • deviceDataMigrated
  • deviceDataReset
  • initialAssignment
  • reprovisionedToInitialAssignment

Subestado para dispositivos "Asignados". Los valores posibles incluyen : "initialAssignment": el dispositivo se ha asignado a un centro de IoT por primera vez, "deviceDataMigrated": el dispositivo se ha asignado a otro centro de IoT y sus datos de dispositivo se migraron desde el centro de IoT asignado anteriormente. Los datos del dispositivo se quitaron del centro de IoT asignado anteriormente, "deviceDataReset": el dispositivo se ha asignado a otro centro de IoT y sus datos de dispositivo se rellenaron desde el estado inicial almacenado en la inscripción. Los datos del dispositivo se quitaron del centro de IoT asignado anteriormente, "reprovisionedToInitialAssignment": el dispositivo se ha vuelto a aprovisionar en un centro de IoT asignado previamente.

IndividualEnrollment

Object

Registro de inscripción de dispositivos.

Nombre Tipo Valor predeterminado Description
allocationPolicy enum:
  • custom
  • geoLatency
  • hashed
  • static

Directiva de asignación de este recurso. Esta directiva invalida la directiva de asignación de nivel de inquilino para esta inscripción individual o grupo de inscripción. Entre los valores posibles se incluyen "hashed": es igualmente probable que los centros de IoT vinculados tengan dispositivos aprovisionados, "geoLatency": los dispositivos se aprovisionan en un centro de IoT con la latencia más baja para el dispositivo. Si varios centros de IoT vinculados proporcionarían la misma latencia más baja, los dispositivos hash del servicio de aprovisionamiento en esos centros, "estáticos": la especificación del centro de IoT deseado en la lista de inscripción tiene prioridad sobre la directiva de asignación de nivel de servicio, "personalizada": los dispositivos se aprovisionan en un centro de IoT basado en su propia lógica personalizada. El servicio de aprovisionamiento pasa información sobre el dispositivo a la lógica y la lógica devuelve el centro de IoT deseado, así como la configuración inicial deseada. Se recomienda usar Azure Functions para hospedar la lógica.
attestation

AttestationMechanism

Mecanismo de atestación para individualEnrollment, así como enrollmentGroup.
capabilities

DeviceCapabilities

Funcionalidades del dispositivo.
createdDateTimeUtc

string (date-time)

DateTime que se creó este recurso.
customAllocationDefinition

CustomAllocationDefinition

Esto indica a DPS a qué webhook llamar al usar la asignación personalizada.
deviceId

string

Id. de dispositivo de IoT Hub deseado (opcional).
etag

string

Etiqueta de entidad asociada al recurso.
initialTwin

InitialTwin

Dispositivo gemelo inicial. Contiene un subconjunto de las propiedades de Twin.
iotHubHostName

string

Nombre de host de IoT Hub.
iotHubs

string[]

La lista de nombres de host de IoT Hub a los que se pueden asignar los dispositivos de este recurso. Debe ser un subconjunto de la lista de nivel de inquilino de ioT Hubs.
lastUpdatedDateTimeUtc

string (date-time)

DateTime que este recurso se actualizó por última vez.
optionalDeviceInformation

TwinCollection

Representa una colección de propiedades dentro de un gemelo.
provisioningStatus enum:
  • disabled
  • enabled
enabled

Estado de aprovisionamiento.
registrationId

string

minLength: 1

Este identificador se usa para identificar de forma única un registro de dispositivo de una inscripción. Cadena que no distingue mayúsculas de minúsculas (hasta 128 caracteres de largo) de caracteres alfanuméricos más determinados caracteres especiales: . _ -. No se permiten caracteres especiales al principio o al final.
registrationState

DeviceRegistrationState

Estado de registro del dispositivo.
reprovisionPolicy

ReprovisionPolicy

El comportamiento del servicio cuando se vuelve a aprovisionar un dispositivo en un centro de IoT.

InitialTwin

Object

Dispositivo gemelo inicial. Contiene un subconjunto de las propiedades de Twin.

Nombre Tipo Description
properties

InitialTwinProperties

Representa las propiedades iniciales que se establecerán en el dispositivo gemelo.
tags

TwinCollection

Representa una colección de propiedades dentro de un gemelo.

InitialTwinProperties

Object

Representa las propiedades iniciales que se establecerán en el dispositivo gemelo.

Nombre Tipo Description
desired

TwinCollection

Representa una colección de propiedades dentro de un gemelo.

Metadata

Object

Metadatos de TwinCollection

Nombre Tipo Description
lastUpdated

string (date-time)

Última vez que se actualizó TwinCollection
lastUpdatedVersion

integer (int64)

Esto es null para los metadatos de propiedades notificadas y no es NULL para los metadatos de propiedades deseadas.

ProvisioningServiceErrorDetails

Object

Contiene las propiedades de un error devuelto por el servicio de aprovisionamiento de Azure IoT Hub.

Nombre Tipo Description
errorCode

integer (int32)

info

object

message

string

timestampUtc

string (date-time)

trackingId

string

ReprovisionPolicy

Object

El comportamiento del servicio cuando se vuelve a aprovisionar un dispositivo en un centro de IoT.

Nombre Tipo Valor predeterminado Description
migrateDeviceData

boolean

True

Cuando se establece en true (valor predeterminado), Device Provisioning Service migrará los datos del dispositivo (gemelo, funcionalidades de dispositivo e identificador de dispositivo) de un centro de IoT a otro durante una actualización de asignación de IoT Hub. Si se establece en false, Device Provisioning Service restablecerá los datos del dispositivo a la configuración deseada inicial almacenada en la lista de inscripción correspondiente.
updateHubAssignment

boolean

True

Cuando se establece en true (valor predeterminado), Device Provisioning Service evaluará la asignación de IoT Hub del dispositivo y la actualizará si es necesario para las solicitudes de aprovisionamiento posteriores a la primera desde un dispositivo determinado. Si se establece en false, el dispositivo permanecerá asignado a su centro de IoT actual.

SymmetricKeyAttestation

Object

Atestación a través de SymmetricKey.

Nombre Tipo Description
primaryKey

string

Clave simétrica principal.
secondaryKey

string

Clave simétrica secundaria.

TpmAttestation

Object

Atestación a través de TPM.

Nombre Tipo Description
endorsementKey

string

storageRootKey

string

TwinCollection

Object

Representa una colección de propiedades dentro de un gemelo.

Nombre Tipo Description
count

integer

Número de propiedades de TwinCollection
metadata

Metadata

Metadatos de TwinCollection
version

integer (int64)

Versión de TwinCollection

X509Attestation

Object

Atestación a través de X509.

Nombre Tipo Description
caReferences

X509CAReferences

Referencias de entidad de certificación principal y secundaria.
clientCertificates

X509Certificates

Certificados principales y secundarios
signingCertificates

X509Certificates

Certificados principales y secundarios

X509CAReferences

Object

Referencias de entidad de certificación principal y secundaria.

Nombre Tipo Description
primary

string

secondary

string

X509CertificateInfo

Object

Información del certificado X509.

Nombre 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 principales y secundarios

Nombre Tipo Description
primary

X509CertificateWithInfo

Información de certificado y certificado
secondary

X509CertificateWithInfo

Información de certificado y certificado

X509CertificateWithInfo

Object

Información de certificado y certificado

Nombre Tipo Description
certificate

string

info

X509CertificateInfo

Información del certificado X509.