Partager via

Individual Enrollment - Create Or Update

  • Référence
Service:
IoT Hub Device Provisioning Service
Version d'API:
2021-10-01

Create ou mettre à jour un enregistrement d’inscription d’appareil.

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

Paramètres URI

Nom Dans Obligatoire Type Description
id
 path True

string

Cet ID est utilisé pour identifier de manière unique une inscription d’appareil d’une inscription. Chaîne ne respectant pas la casse (jusqu’à 128 caractères) de caractères alphanumériques plus certains caractères spéciaux : . _ -. Aucun caractère spécial autorisé au début ou à la fin.
api-version
 query True

string

Version de l’API à utiliser pour la requête. Versions prises en charge : 2021-10-01

En-tête de la demande

Nom Obligatoire Type Description
If-Match

string

ETag de l’enregistrement d’inscription.

Corps de la demande

Nom Obligatoire Type Description
attestation True

AttestationMechanism

Mécanisme d’attestation pour individualEnrollment et enrollmentGroup.
registrationId True

string

Cet ID est utilisé pour identifier de manière unique une inscription d’appareil. Chaîne non sensible à la casse (jusqu’à 128 caractères) de caractères alphanumériques plus certains caractères spéciaux : . _ -. Aucun caractère spécial autorisé au début ou à la fin.
allocationPolicy enum:
  • hashed
  • geoLatency
  • static
  • custom

Stratégie d’allocation de cette ressource. Cette stratégie remplace la stratégie d’allocation au niveau du locataire pour cette inscription individuelle ou ce groupe d’inscriptions. Les valeurs possibles sont « hachées » : les hubs IoT liés sont également susceptibles d’avoir des appareils approvisionnés, « géoLatency » : les appareils sont approvisionnés sur un hub IoT avec la latence la plus faible pour l’appareil. Si plusieurs hubs IoT liés fournissent la même latence la plus faible, le service d’approvisionnement hachage les appareils sur ces hubs, « statique » : la spécification du hub IoT souhaité dans la liste d’inscriptions est prioritaire sur la stratégie d’allocation au niveau du service, « personnalisé » : les appareils sont provisionnés sur un hub IoT en fonction de votre propre logique personnalisée. Le service d’approvisionnement transmet des informations sur l’appareil à la logique, et la logique retourne le hub IoT souhaité, ainsi que la configuration initiale souhaitée. Nous vous recommandons d’utiliser Azure Functions pour héberger votre logique.
capabilities

DeviceCapabilities

Fonctionnalités de l’appareil.
customAllocationDefinition

CustomAllocationDefinition

Cela indique à DPS le webhook à appeler lors de l’utilisation de l’allocation personnalisée.
deviceId

string

ID d’appareil souhaité IoT Hub (facultatif).
etag

string

Balise d’entité associée à la ressource.
initialTwin

InitialTwin

Jumeau d’appareil initial. Contient un sous-ensemble des propriétés de Twin.
iotHubHostName

string

Nom d’hôte Iot Hub.
iotHubs

string[]

Liste des noms d’hôte IoT Hub les appareils de cette ressource peuvent être alloués. Doit être un sous-ensemble de la liste de hubs IoT au niveau du locataire.
optionalDeviceInformation

TwinCollection

Représente une collection de propriétés au sein d’un jumeau
provisioningStatus enum:
  • enabled
  • disabled

Status d’approvisionnement.
registrationState

DeviceRegistrationState

État d’inscription de l’appareil.
reprovisionPolicy

ReprovisionPolicy

Comportement du service lorsqu’un appareil est reprovisionné sur un hub IoT.

Réponses

Nom Type Description
200 OK

IndividualEnrollment

Succès
Other Status Codes

ProvisioningServiceErrorDetails

Réponse d’erreur

En-têtes

x-ms-error-code: string

Définitions

Nom Description
AttestationMechanism

Mécanisme d’attestation pour individualEnrollment et enrollmentGroup.
CustomAllocationDefinition

Cela indique à DPS quel webhook appeler lors de l’utilisation de l’allocation personnalisée.
DeviceCapabilities

Fonctionnalités de l’appareil.
DeviceRegistrationState

État d’inscription de l’appareil.
IndividualEnrollment

Enregistrement d’inscription d’appareil.
InitialTwin

Jumeau d’appareil initial. Contient un sous-ensemble des propriétés de Twin.
InitialTwinProperties

Représente les propriétés initiales qui seront définies sur le jumeau d’appareil.
Metadata

Métadonnées pour twinCollection
ProvisioningServiceErrorDetails

Contient les propriétés d’une erreur retournée par le service d’approvisionnement Azure IoT Hub.
ReprovisionPolicy

Comportement du service lorsqu’un appareil est réapprovisionnement dans un hub IoT.
SymmetricKeyAttestation

Attestation via SymmetricKey.
TpmAttestation

Attestation via TPM.
TwinCollection

Représente une collection de propriétés au sein d’un jumeau
X509Attestation

Attestation via X509.
X509CAReferences

Références d’autorité de certification primaire et secondaire.
X509CertificateInfo

Informations de certificat X509.
X509Certificates

Certificats principaux et secondaires
X509CertificateWithInfo

Informations sur le certificat et le certificat

AttestationMechanism

Mécanisme d’attestation pour individualEnrollment et enrollmentGroup.

Nom Type Description
symmetricKey

SymmetricKeyAttestation

Attestation via SymmetricKey.
tpm

TpmAttestation

Attestation via TPM.
type enum:
  • none
  • symmetricKey
  • tpm
  • x509

Type d’attestation.
x509

X509Attestation

Attestation via X509.

CustomAllocationDefinition

Cela indique à DPS quel webhook appeler lors de l’utilisation de l’allocation personnalisée.

Nom Type Description
apiVersion

string

Version d’API des types de service d’approvisionnement (par exemple, IndividualEnrollment) envoyée dans la demande d’allocation personnalisée. Version minimale prise en charge : « 2018-09-01-preview ».
webhookUrl

string

URL de webhook utilisée pour les demandes d’allocation.

DeviceCapabilities

Fonctionnalités de l’appareil.

Nom Type Valeur par défaut Description
iotEdge

boolean

False

S’il est défini sur true, cet appareil est un appareil IoTEdge.

DeviceRegistrationState

État d’inscription de l’appareil.

Nom Type Description
assignedHub

string

Azure IoT Hub affectée.
createdDateTimeUtc

string

L’inscription crée la date d’heure (en UTC).
deviceId

string

ID de périphérique.
errorCode

integer

Code d’erreur.
errorMessage

string

Message d’erreur.
etag

string

Balise d’entité associée à la ressource.
lastUpdatedDateTimeUtc

string

Date d’heure de la dernière mise à jour (en UTC).
payload

object

registrationId

string

Cet ID est utilisé pour identifier de manière unique une inscription d’appareil. Chaîne non sensible à la casse (jusqu’à 128 caractères) de caractères alphanumériques plus certains caractères spéciaux : . _ -. Aucun caractère spécial autorisé au début ou à la fin.
status enum:
  • assigned
  • assigning
  • disabled
  • failed
  • unassigned

Inscription status.
substatus enum:
  • deviceDataMigrated
  • deviceDataReset
  • initialAssignment
  • reprovisionedToInitialAssignment

Sous-état pour les appareils « affectés ». Les valeurs possibles incluent : « initialAssignment » : l’appareil a été affecté à un hub IoT pour la première fois, « deviceDataMigrated » : l’appareil a été affecté à un autre hub IoT et ses données d’appareil ont été migrées à partir du hub IoT précédemment attribué. Les données d’appareil ont été supprimées du hub IoT précédemment affecté, « deviceDataReset » : l’appareil a été affecté à un autre hub IoT et ses données d’appareil ont été remplies à partir de l’état initial stocké dans l’inscription. Les données de l’appareil ont été supprimées du hub IoT précédemment attribué, « reprovisionedToInitialAssignment » : l’appareil a été réapprovisionné sur un hub IoT précédemment affecté.

IndividualEnrollment

Enregistrement d’inscription d’appareil.

Nom Type Valeur par défaut Description
allocationPolicy enum:
  • custom
  • geoLatency
  • hashed
  • static

Stratégie d’allocation de cette ressource. Cette stratégie remplace la stratégie d’allocation au niveau du locataire pour cette inscription individuelle ou ce groupe d’inscriptions. Les valeurs possibles incluent « hachage » : les hubs IoT liés sont également susceptibles d’avoir des appareils approvisionnés, « géoLatency » : les appareils sont approvisionnés sur un hub IoT avec la latence la plus faible sur l’appareil. Si plusieurs hubs IoT liés offrent la même latence la plus faible, le service d’approvisionnement hache les appareils sur ces hubs, « statique » : la spécification du hub IoT souhaité dans la liste d’inscriptions est prioritaire sur la stratégie d’allocation au niveau du service, « personnalisée » : les appareils sont provisionnés sur un hub IoT en fonction de votre propre logique personnalisée. Le service d’approvisionnement transmet des informations sur l’appareil à la logique, et la logique retourne le hub IoT souhaité ainsi que la configuration initiale souhaitée. Nous vous recommandons d’utiliser Azure Functions pour héberger votre logique.
attestation

AttestationMechanism

Mécanisme d’attestation pour individualEnrollment et enrollmentGroup.
capabilities

DeviceCapabilities

Fonctionnalités de l’appareil.
createdDateTimeUtc

string

DateTime cette ressource a été créée.
customAllocationDefinition

CustomAllocationDefinition

Cela indique à DPS quel webhook appeler lors de l’utilisation de l’allocation personnalisée.
deviceId

string

ID d’appareil souhaité IoT Hub (facultatif).
etag

string

Balise d’entité associée à la ressource.
initialTwin

InitialTwin

Jumeau d’appareil initial. Contient un sous-ensemble des propriétés de Twin.
iotHubHostName

string

Nom d’hôte Iot Hub.
iotHubs

string[]

Liste des noms d’hôte IoT Hub les appareils de cette ressource peuvent être alloués. Doit être un sous-ensemble de la liste au niveau du locataire des hubs IoT.
lastUpdatedDateTimeUtc

string

DateTime Cette ressource a été mise à jour pour la dernière fois.
optionalDeviceInformation

TwinCollection

Représente une collection de propriétés au sein d’un jumeau
provisioningStatus enum:
  • disabled
  • enabled
enabled

Status d’approvisionnement.
registrationId

string

Cet ID est utilisé pour identifier de manière unique une inscription d’appareil. Chaîne non sensible à la casse (jusqu’à 128 caractères) de caractères alphanumériques plus certains caractères spéciaux : . _ -. Aucun caractère spécial autorisé au début ou à la fin.
registrationState

DeviceRegistrationState

État d’inscription de l’appareil.
reprovisionPolicy

ReprovisionPolicy

Comportement du service lorsqu’un appareil est réapprovisionnement dans un hub IoT.

InitialTwin

Jumeau d’appareil initial. Contient un sous-ensemble des propriétés de Twin.

Nom Type Description
properties

InitialTwinProperties

Représente les propriétés initiales qui seront définies sur le jumeau d’appareil.
tags

TwinCollection

Représente une collection de propriétés au sein d’un jumeau

InitialTwinProperties

Représente les propriétés initiales qui seront définies sur le jumeau d’appareil.

Nom Type Description
desired

TwinCollection

Représente une collection de propriétés au sein d’un jumeau

Metadata

Métadonnées pour twinCollection

Nom Type Description
lastUpdated

string

Dernière mise à jour de TwinCollection
lastUpdatedVersion

integer

Cette valeur est null pour les métadonnées de propriétés signalées et n’est pas null pour les métadonnées de propriétés souhaitées.

ProvisioningServiceErrorDetails

Contient les propriétés d’une erreur retournée par le service d’approvisionnement Azure IoT Hub.

Nom Type Description
errorCode

integer

info

object

message

string

timestampUtc

string

trackingId

string

ReprovisionPolicy

Comportement du service lorsqu’un appareil est réapprovisionnement dans un hub IoT.

Nom Type Valeur par défaut Description
migrateDeviceData

boolean

True

Lorsqu’il est défini sur true (valeur par défaut), le service Device Provisioning migre les données de l’appareil (jumeau, fonctionnalités de l’appareil et ID de l’appareil) d’un hub IoT à un autre pendant une mise à jour d’affectation IoT Hub. Si la valeur est false, le service Device Provisioning réinitialise les données de l’appareil à la configuration initiale souhaitée stockée dans la liste d’inscription correspondante.
updateHubAssignment

boolean

True

Lorsqu’il est défini sur true (valeur par défaut), le service Device Provisioning évalue l’affectation de IoT Hub de l’appareil et le met à jour si nécessaire pour toutes les demandes d’approvisionnement au-delà de la première à partir d’un appareil donné. Si la valeur est false, l’appareil reste affecté à son hub IoT actuel.

SymmetricKeyAttestation

Attestation via SymmetricKey.

Nom Type Description
primaryKey

string

Clé symétrique primaire.
secondaryKey

string

Clé symétrique secondaire.

TpmAttestation

Attestation via TPM.

Nom Type Description
endorsementKey

string

storageRootKey

string

TwinCollection

Représente une collection de propriétés au sein d’un jumeau

Nom Type Description
count

integer

Nombre de propriétés dans TwinCollection
metadata

Metadata

Métadonnées pour twinCollection
version

integer

Version de TwinCollection

X509Attestation

Attestation via X509.

Nom Type Description
caReferences

X509CAReferences

Références d’autorité de certification primaire et secondaire.
clientCertificates

X509Certificates

Certificats principaux et secondaires
signingCertificates

X509Certificates

Certificats principaux et secondaires

X509CAReferences

Références d’autorité de certification primaire et secondaire.

Nom Type Description
primary

string

secondary

string

X509CertificateInfo

Informations de certificat X509.

Nom Type Description
issuerName

string

notAfterUtc

string

notBeforeUtc

string

serialNumber

string

sha1Thumbprint

string

sha256Thumbprint

string

subjectName

string

version

integer

X509Certificates

Certificats principaux et secondaires

Nom Type Description
primary

X509CertificateWithInfo

Informations sur le certificat et le certificat
secondary

X509CertificateWithInfo

Informations sur le certificat et le certificat

X509CertificateWithInfo

Informations sur le certificat et le certificat

Nom Type Description
certificate

string

info

X509CertificateInfo

Informations de certificat X509.