Enrollment Group - Get

Service:: IoT Hub Device Provisioning Service

Version d'API:: 2021-10-01

Obtenir un groupe d’inscription d’appareil.

GET https://{dpsName}.azure-devices-provisioning.net/enrollmentGroups/{id}?api-version=2021-10-01

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
dpsName	path	True	string	Le nom d’hôte de l’instance DPS.
id	path	True	string	ID de groupe d’inscription.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

En-tête de la demande

Nom	Obligatoire	Type	Description
Authorization	True	string

Réponses

Nom	Type	Description
200 OK	EnrollmentGroup	La demande a réussi.
Other Status Codes	ProvisioningServiceErrorDetails	Réponse d’erreur inattendue. En-têtes x-ms-error-code: string

Nom

Type

Description

200 OK

EnrollmentGroup

La demande a réussi.

Other Status Codes

ProvisioningServiceErrorDetails

Réponse d’erreur inattendue.

En-têtes

x-ms-error-code: string

Sécurité

Authorization

Type: apiKey
Dans: header

Exemples

EnrollmentGroup_Get_MaximumSet_Gen

EnrollmentGroup_Get_MinimumSet_Gen

EnrollmentGroup_Get_MaximumSet_Gen

Exemple de requête

HTTP

GET https://{dpsName}.azure-devices-provisioning.net/enrollmentGroups/aeejtkwwsgoraodfdlh?api-version=2021-10-01

Exemple de réponse

Code d’état:: 200

{
  "allocationPolicy": "hashed",
  "attestation": {
    "type": "none",
    "symmetricKey": {
      "primaryKey": "tdoshkmlo",
      "secondaryKey": "lmajoyzuojahffcmdlcwjhntqzyqzk"
    },
    "tpm": {
      "endorsementKey": "naoofgjbxiulcitlysusxdvagyucgn",
      "storageRootKey": "tdgkgcvptrsw"
    },
    "x509": {
      "caReferences": {
        "primary": "efbkbboxkvrsdl",
        "secondary": "vckhuzqgbcinighxwyuyd"
      },
      "clientCertificates": {
        "primary": {
          "info": {
            "issuerName": "pkuinyhttjlozsbtvxuizzkjlakga",
            "notAfterUtc": "2025-10-01T17:42:04.760Z",
            "notBeforeUtc": "2025-10-01T17:42:04.760Z",
            "serialNumber": "mzoidcxayenpgyrek",
            "sha1Thumbprint": "fdmftjqllzvxcd",
            "sha256Thumbprint": "ei",
            "subjectName": "qqjdjgrkiqvtnshkisozut",
            "version": 12
          },
          "certificate": "gkozpt"
        },
        "secondary": {
          "info": {
            "issuerName": "pkuinyhttjlozsbtvxuizzkjlakga",
            "notAfterUtc": "2025-10-01T17:42:04.760Z",
            "notBeforeUtc": "2025-10-01T17:42:04.760Z",
            "serialNumber": "mzoidcxayenpgyrek",
            "sha1Thumbprint": "fdmftjqllzvxcd",
            "sha256Thumbprint": "ei",
            "subjectName": "qqjdjgrkiqvtnshkisozut",
            "version": 12
          },
          "certificate": "gkozpt"
        }
      },
      "signingCertificates": {
        "primary": {
          "info": {
            "issuerName": "pkuinyhttjlozsbtvxuizzkjlakga",
            "notAfterUtc": "2025-10-01T17:42:04.760Z",
            "notBeforeUtc": "2025-10-01T17:42:04.760Z",
            "serialNumber": "mzoidcxayenpgyrek",
            "sha1Thumbprint": "fdmftjqllzvxcd",
            "sha256Thumbprint": "ei",
            "subjectName": "qqjdjgrkiqvtnshkisozut",
            "version": 12
          },
          "certificate": "gkozpt"
        },
        "secondary": {
          "info": {
            "issuerName": "pkuinyhttjlozsbtvxuizzkjlakga",
            "notAfterUtc": "2025-10-01T17:42:04.760Z",
            "notBeforeUtc": "2025-10-01T17:42:04.760Z",
            "serialNumber": "mzoidcxayenpgyrek",
            "sha1Thumbprint": "fdmftjqllzvxcd",
            "sha256Thumbprint": "ei",
            "subjectName": "qqjdjgrkiqvtnshkisozut",
            "version": 12
          },
          "certificate": "gkozpt"
        }
      }
    }
  },
  "capabilities": {
    "iotEdge": true
  },
  "createdDateTimeUtc": "2025-10-01T17:42:05.495Z",
  "customAllocationDefinition": {
    "apiVersion": "gbannxdstouqrfonxdxfurv",
    "webhookUrl": "todqbubyxeumrtvhsscedwrkz"
  },
  "enrollmentGroupId": "sfsevlobqfdnqmghunj",
  "etag": "kmvtdrkjyfzj",
  "initialTwin": {
    "properties": {
      "desired": {
        "count": 16,
        "key2428": {},
        "metadata": {
          "lastUpdated": "2025-10-01T17:42:04.760Z",
          "lastUpdatedVersion": 19
        },
        "version": 9
      }
    },
    "tags": {
      "count": 16,
      "key2428": {},
      "metadata": {
        "lastUpdated": "2025-10-01T17:42:04.760Z",
        "lastUpdatedVersion": 19
      },
      "version": 9
    }
  },
  "iotHubHostName": "dey",
  "iotHubs": [
    "ehqilokxpijrvaigiaf"
  ],
  "lastUpdatedDateTimeUtc": "2025-10-01T17:42:05.495Z",
  "provisioningStatus": "enabled",
  "reprovisionPolicy": {
    "migrateDeviceData": true,
    "updateHubAssignment": true
  }
}

EnrollmentGroup_Get_MinimumSet_Gen

Exemple de requête

HTTP

GET https://{dpsName}.azure-devices-provisioning.net/enrollmentGroups/foizrzwygyrulkdxcyb?api-version=2021-10-01

Exemple de réponse

Code d’état:: 200

{
  "attestation": {
    "type": "none"
  },
  "enrollmentGroupId": "sfsevlobqfdnqmghunj"
}

Définitions

Nom	Description
AllocationPolicy	La politique d’allocation de cette ressource. Cette politique prime sur la politique d’allocation au niveau locataire pour cet enregistrement individuel ou ce groupe d’inscription. Les valeurs possibles incluent « haché » : les hubs IoT liés ont tout autant de chances d’avoir des appareils provisionnés, « geoLatency » : les appareils sont provisionnés vers un hub IoT avec la latence la plus faible vers l’appareil. Si plusieurs hubs IoT liés offrent la même latence minimale, le service de provisionnement hache les appareils à travers ces hubs, « statique » : La spécification du hub IoT souhaité dans la liste d’inscription a priorité sur la politique d’allocation par niveau de service, « personnalisée » : Les appareils sont provisionnés dans un hub IoT selon votre propre logique personnalisée. Le service de provisionnement transmet des informations sur l’appareil à la logique, et la logique renvoie le hub IoT souhaité ainsi que la configuration initiale désirée. Nous recommandons d’utiliser Azure Functions pour héberger votre logique.
AttestationMechanism	Mécanisme d’attestation pour l’inscription individuelle ainsi que pour le Groupe d’inscription.
AttestationType	Type d’attestation.
CustomAllocationDefinition	Cela indique au DPS quel webhook appeler lorsqu’on utilise une allocation personnalisée.
DeviceCapabilities	Capacités de l’appareil.
EnrollmentGroup	Dossier du groupe d’inscription.
InitialTwin	Appareil initial jumeau. 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 de l’appareil.
Metadata	Métadonnées pour la TwinCollection
ProvisioningServiceErrorDetails	Contient les propriétés d’une erreur retournée par le service de provisionnement Azure IoT Hub.
ProvisioningStatus	Le statut de provisionnement.
ReprovisionPolicy	Le comportement du service lorsqu’un appareil est re-provisionné dans un hub IoT.
SymmetricKeyAttestation	Attestation via SymmetricKey.
TpmAttestation	Attestation via TPM.
TwinCollection	Représente un ensemble de propriétés au sein d’un jumeau
X509Attestation	Attestation via X509.
X509CAReferences	Références CA primaires et secondaires.
X509CertificateInfo	Informations sur le certificat X509.
X509Certificates	Certificats primaires et secondaires
X509CertificateWithInfo	Certificat et informations sur les certificats

AllocationPolicy

Énumération

La politique d’allocation de cette ressource. Cette politique prime sur la politique d’allocation au niveau locataire pour cet enregistrement individuel ou ce groupe d’inscription. Les valeurs possibles incluent « haché » : les hubs IoT liés ont tout autant de chances d’avoir des appareils provisionnés, « geoLatency » : les appareils sont provisionnés vers un hub IoT avec la latence la plus faible vers l’appareil. Si plusieurs hubs IoT liés offrent la même latence minimale, le service de provisionnement hache les appareils à travers ces hubs, « statique » : La spécification du hub IoT souhaité dans la liste d’inscription a priorité sur la politique d’allocation par niveau de service, « personnalisée » : Les appareils sont provisionnés dans un hub IoT selon votre propre logique personnalisée. Le service de provisionnement transmet des informations sur l’appareil à la logique, et la logique renvoie le hub IoT souhaité ainsi que la configuration initiale désirée. Nous recommandons d’utiliser Azure Functions pour héberger votre logique.

Valeur	Description
hashed	haché
geoLatency	geoLatency
static	statique
custom	coutume

AttestationMechanism

Objet

Mécanisme d’attestation pour l’inscription individuelle ainsi que pour le Groupe d’inscription.

Nom	Type	Description
symmetricKey	SymmetricKeyAttestation	Méthode d’attestation de clé symétrique.
tpm	TpmAttestation	Méthode d’attestation TPM.
type	AttestationType	Type d’attestation.
x509	X509Attestation	Méthode d’attestation X509.

AttestationType

Énumération

Type d’attestation.

Valeur	Description
none	aucune
tpm	tpm
x509	x509
symmetricKey	symmetricKey

CustomAllocationDefinition

Objet

Cela indique au DPS quel webhook appeler lorsqu’on utilise une allocation personnalisée.

Nom	Type	Description
apiVersion	string	La version API des types de services de provisionnement (comme IndividualEnrollment) envoyait dans la requête d’allocation personnalisée. Version minimale prise en charge : « 2018-09-01-preview ».
webhookUrl	string	L’URL du webhook utilisée pour les demandes d’allocation.

DeviceCapabilities

Objet

Capacités de l’appareil.

Nom	Type	Valeur par défaut	Description
iotEdge	boolean	False	Si elle est réglée sur true, ce dispositif est un appareil IoTEdge.

EnrollmentGroup

Objet

Dossier du groupe d’inscription.

Nom	Type	Valeur par défaut	Description
allocationPolicy	AllocationPolicy		La politique d’allocation de cette ressource. Cette politique prime sur la politique d’allocation au niveau locataire pour cet enregistrement individuel ou ce groupe d’inscription. Les valeurs possibles incluent « haché » : les hubs IoT liés ont tout autant de chances d’avoir des appareils provisionnés, « geoLatency » : les appareils sont provisionnés vers un hub IoT avec la latence la plus faible vers l’appareil. Si plusieurs hubs IoT liés offrent la même latence minimale, le service de provisionnement hache les appareils à travers ces hubs, « statique » : La spécification du hub IoT souhaité dans la liste d’inscription a priorité sur la politique d’allocation par niveau de service, « personnalisée » : Les appareils sont provisionnés dans un hub IoT selon votre propre logique personnalisée. Le service de provisionnement transmet des informations sur l’appareil à la logique, et la logique renvoie le hub IoT souhaité ainsi que la configuration initiale désirée. Nous recommandons d’utiliser Azure Functions pour héberger votre logique.
attestation	AttestationMechanism		Méthode d’attestation utilisée par l’appareil.
capabilities	DeviceCapabilities		Les capacités de l’appareil.
createdDateTimeUtc	string (date-time)		La DateTime cette ressource a été créée.
customAllocationDefinition	CustomAllocationDefinition		Cela indique au DPS quel webhook appeler lorsqu’on utilise une allocation personnalisée.
enrollmentGroupId	string		ID du groupe d’inscription.
etag	string		L’entité tag associée à la ressource.
initialTwin	InitialTwin		Appareil initial jumeau.
iotHubHostName	string		Le nom hôte Iot Hub.
iotHubs	string[]		La liste des noms d’hôte IoT Hub auxquels l’appareil ou les appareils de cette ressource peut être alloué. Il doit s’agir d’un sous-ensemble de la liste locataire des hubs IoT.
lastUpdatedDateTimeUtc	string (date-time)		La DateHeure : cette ressource a été mise à jour pour la dernière fois.
provisioningStatus	ProvisioningStatus	enabled	Le statut de provisionnement.
reprovisionPolicy	ReprovisionPolicy		Le comportement lorsqu’un appareil est re-provisionné dans un hub IoT.

InitialTwin

Objet

Appareil initial jumeau. Contient un sous-ensemble des propriétés de Twin.

Nom	Type	Description
properties	InitialTwinProperties	Propriétés souhaitées du jumeau.
tags	TwinCollection	Balises de jumeau.

InitialTwinProperties

Objet

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

Nom	Type	Description
desired	TwinCollection	Obtient et définit les propriétés désirées par InitialTwin.

Metadata

Objet

Métadonnées pour la TwinCollection

Nom	Type	Description
lastUpdated	string (date-time)	La dernière fois, la TwinCollection a été mise à jour
lastUpdatedVersion	integer (int32)	Ceci est nul pour les métadonnées des propriétés rapportées et n’est pas nul pour les métadonnées des propriétés souhaitées.

ProvisioningServiceErrorDetails

Objet

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

Nom	Type	Description
errorCode	integer (int32)	Code d’erreur pour l’opération.
info	object	Dictionnaire de <chaîne>
message	string	Message d’erreur lisible par l’humain.
timestampUtc	string (date-time)	Horodatage UTC de l’erreur.
trackingId	string	ID de suivi pour l’erreur.

ProvisioningStatus

Énumération

Le statut de provisionnement.

Valeur	Description
enabled	enabled
disabled	handicapé

ReprovisionPolicy

Objet

Le comportement du service lorsqu’un appareil est re-provisionné dans un hub IoT.

Nom	Type	Valeur par défaut	Description
migrateDeviceData	boolean	True	Lorsqu’il est réglé sur true (par défaut), le Service de Provisionnement des Appareils migre les données de l’appareil (jumeaux, capacités de l’appareil et ID de l’appareil) d’un hub IoT à un autre lors d’une mise à jour d’attribution du hub IoT. Si elle est réglée sur false, le Service de Provisionnement des Dispositifs réinitialisera 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 réglé sur true (par défaut), le Service de Provisionnement des Appareils évalue l’attribution du Hub IoT de l’appareil et la met à jour si nécessaire pour toute demande de provisionnement au-delà de la première provenant d’un appareil donné. Si le mode est faux, l’appareil restera assigné à son hub IoT actuel.

SymmetricKeyAttestation

Objet

Attestation via SymmetricKey.

Nom	Type	Description
primaryKey	string	Clé symétrique primaire.
secondaryKey	string	Clé symétrique secondaire.

TpmAttestation

Objet

Attestation via TPM.

Nom	Type	Description
endorsementKey	string	Clé de l’approbation de TPM.
storageRootKey	string	Clé racine de stockage TPM.

TwinCollection

Objet

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

Nom	Type	Description
count	integer (int32)	Nombre de propriétés dans la TwinCollection
metadata	Metadata	Métadonnées pour la TwinCollection
version	integer (int32)	Version de la TwinCollection

X509Attestation

Objet

Attestation via X509.

Nom	Type	Description
caReferences	X509CAReferences	Références CA primaires et secondaires.
clientCertificates	X509Certificates	Certificats primaires et secondaires
signingCertificates	X509Certificates	Certificats primaires et secondaires

X509CAReferences

Objet

Références CA primaires et secondaires.

Nom	Type	Description
primary	string	Référence principale de la CA.
secondary	string	Référence secondaire CA.

X509CertificateInfo

Objet

Informations sur le certificat X509.

Nom	Type	Description
issuerName	string	Nom de l’émetteur du certificat.
notAfterUtc	string (date-time)	Fin de la validité du certificat (UTC).
notBeforeUtc	string (date-time)	Validation des certificats (UTC).
serialNumber	string	Numéro de série du certificat.
sha1Thumbprint	string	Empreinte digitale SHA-1 du certificat.
sha256Thumbprint	string	Empreinte digitale SHA-256 du certificat.
subjectName	string	Nom de l’objet du certificat.
version	integer (int32)	Version du certificat.

X509Certificates

Objet

Certificats primaires et secondaires

Nom	Type	Description
primary	X509CertificateWithInfo	Certificat et informations sur les certificats
secondary	X509CertificateWithInfo	Certificat et informations sur les certificats

X509CertificateWithInfo

Objet

Certificat et informations sur les certificats

Nom	Type	Description
certificate	string	Chaîne de certificats formatée PEM.
info	X509CertificateInfo	Informations sur le certificat X509.