Enrollment Group - Run Bulk Operation

Service:

IoT Hub Device Provisioning Service

API Version:

2021-10-01

Opération de groupe d’inscription d’appareil en bloc avec un maximum de 10 groupes.

POST https://your-dps.azure-devices-provisioning.net/enrollmentGroups?api-version=2021-10-01

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
api-version	query	True	string	Version de l’API à utiliser pour la requête. Versions prises en charge : 2021-10-01

Corps de la demande

Nom	Obligatoire	Type	Description
enrollmentGroups	True	EnrollmentGroup[]	Éléments d’inscription
mode	True	enum: create update updateIfMatchETag delete	Mode d’opération.

Réponses

Nom	Type	Description
200 OK	BulkEnrollmentGroupOperationResult	Succès
Other Status Codes	ProvisioningServiceErrorDetails	Réponse d’erreur Headers x-ms-error-code: string

Définitions

Nom	Description
AttestationMechanism	Mécanisme d’attestation pour individualEnrollment et enrollmentGroup.
BulkEnrollmentGroupOperation	Opération d’inscription en bloc.
BulkEnrollmentGroupOperationError	Erreur d’opération d’inscription en bloc.
BulkEnrollmentGroupOperationResult	Résultats d’une opération de groupe d’inscription en bloc.
CustomAllocationDefinition	Cela indique à DPS le webhook à appeler lors de l’utilisation de l’allocation personnalisée.
DeviceCapabilities	Fonctionnalités de l’appareil.
EnrollmentGroup	Enregistrement de groupe d’inscription.
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 reprovisionné sur un hub IoT.
SymmetricKeyAttestation	Attestation via SymmetricKey.
TpmAttestation	Attestation via TPM.
TwinCollection	Représente une collection de propriétés dans un jumeau
X509Attestation	Attestation via X509.
X509CAReferences	Références d’autorité de certification principale 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.

BulkEnrollmentGroupOperation

Opération d’inscription en bloc.

Nom	Type	Description
enrollmentGroups	EnrollmentGroup[]	Éléments d’inscription
mode	enum: create delete update updateIfMatchETag	Mode d’opération.

BulkEnrollmentGroupOperationError

Erreur d’opération d’inscription en bloc.

Nom	Type	Description
enrollmentGroupId	string	ID du groupe d’inscription.
errorCode	integer	Code d'erreur
errorStatus	string	Erreur status.

BulkEnrollmentGroupOperationResult

Résultats d’une opération de groupe d’inscription en bloc.

Nom	Type	Description
errors	BulkEnrollmentGroupOperationError[]	Erreurs d'inscription
isSuccessful	boolean	Indique si l’opération a réussi dans son intégralité.

CustomAllocationDefinition

Cela indique à DPS le 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.

EnrollmentGroup

Enregistrement de groupe d’inscription.

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 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.
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 le webhook à appeler lors de l’utilisation de l’allocation personnalisée.
enrollmentGroupId	string		ID de groupe d’inscription.
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.
lastUpdatedDateTimeUtc	string		DateTime cette ressource a été mise à jour pour la dernière fois.
provisioningStatus	enum: disabled enabled	enabled	Status d’approvisionnement.
reprovisionPolicy	ReprovisionPolicy		Comportement du service lorsqu’un appareil est reprovisionné sur 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 dans 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 dans 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 des propriétés signalées et n’est pas null pour les métadonnées des 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 reprovisionné sur un hub IoT.

Nom	Type	Valeur par défaut	Description
migrateDeviceData	boolean	True	Quand la valeur est true (valeur par défaut), le service Device Provisioning migre les données de l’appareil (jumeau, fonctionnalités de l’appareil et ID d’appareil) d’un hub IoT vers un autre lors d’une mise à jour de l’affectation du hub IoT. 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 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 dans 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 principale et secondaire.
clientCertificates	X509Certificates	Certificats principaux et secondaires
signingCertificates	X509Certificates	Certificats principaux et secondaires

X509CAReferences

Références d’autorité de certification principale 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.