Enrollment Group - Get

Service:: IoT Hub Device Provisioning Service

API-versie:: 2021-10-01

Haal een apparaatinschrijvingsgroep op.

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

URI-parameters

Name	In	Vereist	Type	Description
dpsName	path	True	string	De hostnaam van de DPS-instantie.
id	path	True	string	Id van inschrijvingsgroep.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagkoptekst

Name	Vereist	Type	Description
Authorization	True	string

Antwoorden

Name	Type	Description
200 OK	EnrollmentGroup	De aanvraag is voltooid.
Other Status Codes	ProvisioningServiceErrorDetails	Een onverwachte foutreactie. Kopteksten x-ms-error-code: string

Name

Type

Description

200 OK

EnrollmentGroup

De aanvraag is voltooid.

Other Status Codes

ProvisioningServiceErrorDetails

Een onverwachte foutreactie.

Kopteksten

x-ms-error-code: string

Beveiliging

Authorization

Type: apiKey
In: header

Voorbeelden

EnrollmentGroup_Get_MaximumSet_Gen

EnrollmentGroup_Get_MinimumSet_Gen

EnrollmentGroup_Get_MaximumSet_Gen

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

Statuscode:: 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

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

Statuscode:: 200

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

Definities

Name	Description
AllocationPolicy	Het allocatiebeleid van deze hulpbron. Dit beleid overrult het toewijzingsbeleid op huurdersniveau voor deze individuele inschrijving of inschrijvingsgroep. Mogelijke waarden zijn onder andere 'gehasht': gekoppelde IoT-hubs hebben evenveel kans om apparaten aan zich te hebben toegewezen, 'geoLatency': Apparaten worden geprovisioneerd aan een IoT-hub met de laagste latentie voor het apparaat. Als meerdere gekoppelde IoT-hubs dezelfde laagste latentie bieden, hasht de provisioning service apparaten over die hubs, 'statisch': De specificatie van de gewenste IoT-hub in de enregistrmentlijst krijgt prioriteit boven het service-level allocatiebeleid, 'custom': Apparaten worden op basis van je eigen aangepaste logica aan een IoT-hub toegewezen. De provisioningservice geeft informatie over het apparaat door aan de logica, waarna de logica de gewenste IoT-hub en de gewenste initiële configuratie terugstuurt. We raden aan om Azure Functions te gebruiken om je logica te hosten.
AttestationMechanism	Attestatiemechanisme voor individueel Inschrijving evenals inschrijvingsgroep.
AttestationType	Attestatietype.
CustomAllocationDefinition	Dit vertelt DPS welke webhook hij moet aanroepen bij gebruik van aangepaste allocatie.
DeviceCapabilities	Apparaatmogelijkheden.
EnrollmentGroup	Inschrijvingsgroeprecord.
InitialTwin	Eerste apparaattweeling. Bevat een deelverzameling van de eigenschappen van Twin.
InitialTwinProperties	Geeft de initiële eigenschappen weer die op de apparaattweeling worden ingesteld.
Metadata	Metadata voor de TwinCollection
ProvisioningServiceErrorDetails	Bevat de eigenschappen van een foutmelding die wordt teruggegeven door de Azure IoT Hub Provisioning Service.
ProvisioningStatus	De bevoorradingsstatus.
ReprovisionPolicy	Het gedrag van de dienst wanneer een apparaat opnieuw wordt geprovisioneerd naar een IoT-hub.
SymmetricKeyAttestation	Attestatie via SymmetricKey.
TpmAttestation	Attestatie via TPM.
TwinCollection	Vertegenwoordigt een verzameling eigenschappen binnen een Twin
X509Attestation	Bevestiging via X509.
X509CAReferences	Primaire en secundaire CA-referenties.
X509CertificateInfo	X509-certificaatinformatie.
X509Certificates	Primaire en secundaire certificaten
X509CertificateWithInfo	Certificaat en certificaatinformatie

AllocationPolicy

Opsomming

Het allocatiebeleid van deze hulpbron. Dit beleid overrult het toewijzingsbeleid op huurdersniveau voor deze individuele inschrijving of inschrijvingsgroep. Mogelijke waarden zijn onder andere 'gehasht': gekoppelde IoT-hubs hebben evenveel kans om apparaten aan zich te hebben toegewezen, 'geoLatency': Apparaten worden geprovisioneerd aan een IoT-hub met de laagste latentie voor het apparaat. Als meerdere gekoppelde IoT-hubs dezelfde laagste latentie bieden, hasht de provisioning service apparaten over die hubs, 'statisch': De specificatie van de gewenste IoT-hub in de enregistrmentlijst krijgt prioriteit boven het service-level allocatiebeleid, 'custom': Apparaten worden op basis van je eigen aangepaste logica aan een IoT-hub toegewezen. De provisioningservice geeft informatie over het apparaat door aan de logica, waarna de logica de gewenste IoT-hub en de gewenste initiële configuratie terugstuurt. We raden aan om Azure Functions te gebruiken om je logica te hosten.

Waarde	Description
hashed	Hashed
geoLatency	geoLatency
static	statisch
custom	custom

AttestationMechanism

Object

Attestatiemechanisme voor individueel Inschrijving evenals inschrijvingsgroep.

Name	Type	Description
symmetricKey	SymmetricKeyAttestation	Symmetrische sleutel-attestatiemethode.
tpm	TpmAttestation	TPM-attestatiemethode.
type	AttestationType	Attestatietype.
x509	X509Attestation	X509 attestatiemethode.

AttestationType

Opsomming

Attestatietype.

Waarde	Description
none	none
tpm	Tpm
x509	x509
symmetricKey	symmetrische sleutel

CustomAllocationDefinition

Object

Dit vertelt DPS welke webhook hij moet aanroepen bij gebruik van aangepaste allocatie.

Name	Type	Description
apiVersion	string	De API-versie van de provisioning-servicetypes (zoals IndividualEnrollment) die het aangepaste toewijzingsverzoek heeft verzonden. Minimaal ondersteunde versie: "2018-09-01-preview".
webhookUrl	string	De webhook-URL die wordt gebruikt voor allocatieverzoeken.

DeviceCapabilities

Object

Apparaatmogelijkheden.

Name	Type	Default value	Description
iotEdge	boolean	False	Als dit op true staat, is dit apparaat een IoTEdge-apparaat.

EnrollmentGroup

Object

Inschrijvingsgroeprecord.

Name	Type	Default value	Description
allocationPolicy	AllocationPolicy		Het allocatiebeleid van deze hulpbron. Dit beleid overrult het toewijzingsbeleid op huurdersniveau voor deze individuele inschrijving of inschrijvingsgroep. Mogelijke waarden zijn onder andere 'gehasht': gekoppelde IoT-hubs hebben evenveel kans om apparaten aan zich te hebben toegewezen, 'geoLatency': Apparaten worden geprovisioneerd aan een IoT-hub met de laagste latentie voor het apparaat. Als meerdere gekoppelde IoT-hubs dezelfde laagste latentie bieden, hasht de provisioning service apparaten over die hubs, 'statisch': De specificatie van de gewenste IoT-hub in de enregistrmentlijst krijgt prioriteit boven het service-level allocatiebeleid, 'custom': Apparaten worden op basis van je eigen aangepaste logica aan een IoT-hub toegewezen. De provisioningservice geeft informatie over het apparaat door aan de logica, waarna de logica de gewenste IoT-hub en de gewenste initiële configuratie terugstuurt. We raden aan om Azure Functions te gebruiken om je logica te hosten.
attestation	AttestationMechanism		Attestatiemethode die door het apparaat wordt gebruikt.
capabilities	DeviceCapabilities		Mogelijkheden van het apparaat.
createdDateTimeUtc	string (date-time)		De DateTime is deze bron gemaakt.
customAllocationDefinition	CustomAllocationDefinition		Dit vertelt DPS welke webhook hij moet aanroepen bij gebruik van aangepaste allocatie.
enrollmentGroupId	string		Inschrijvingsgroep-ID.
etag	string		De entiteitstag die aan de bron is gekoppeld.
initialTwin	InitialTwin		Eerste apparaattweeling.
iotHubHostName	string		De hostnaam van Iot Hub.
iotHubs	string[]		De lijst met IoT Hub-hostnamen waaraan het apparaat/apparaten in deze bron kunnen worden toegewezen. Moet een subset zijn van de tenant-niveau lijst van IoT-hubs.
lastUpdatedDateTimeUtc	string (date-time)		De DateTime die deze bron voor het laatst is bijgewerkt.
provisioningStatus	ProvisioningStatus	enabled	De bevoorradingsstatus.
reprovisionPolicy	ReprovisionPolicy		Het gedrag wanneer een apparaat opnieuw wordt geprovisioneerd naar een IoT-hub.

InitialTwin

Object

Eerste apparaattweeling. Bevat een deelverzameling van de eigenschappen van Twin.

Name	Type	Description
properties	InitialTwinProperties	Gewenste eigenschappen van dubbel.
tags	TwinCollection	Dubbeltags.

InitialTwinProperties

Object

Geeft de initiële eigenschappen weer die op de apparaattweeling worden ingesteld.

Name	Type	Description
desired	TwinCollection	Krijgt en stelt de gewenste eigenschappen van InitialTwin op.

Metadata

Object

Metadata voor de TwinCollection

Name	Type	Description
lastUpdated	string (date-time)	De vorige keer dat de TwinCollection werd bijgewerkt
lastUpdatedVersion	integer (int32)	Dit is nul voor gerapporteerde eigenschappenmetadata en niet nul voor gewenste eigenschappenmetadata.

ProvisioningServiceErrorDetails

Object

Bevat de eigenschappen van een foutmelding die wordt teruggegeven door de Azure IoT Hub Provisioning Service.

Name	Type	Description
errorCode	integer (int32)	Foutcode voor de operatie.
info	object	Woordenlijst van <tekenreeks>
message	string	Voor mensen leesbare foutmelding.
timestampUtc	string (date-time)	UTC-tijdstempel van de fout.
trackingId	string	Tracking-ID voor de foutmelding.

ProvisioningStatus

Opsomming

De bevoorradingsstatus.

Waarde	Description
enabled	enabled
disabled	uitgeschakeld

ReprovisionPolicy

Object

Het gedrag van de dienst wanneer een apparaat opnieuw wordt geprovisioneerd naar een IoT-hub.

Name	Type	Default value	Description
migrateDeviceData	boolean	True	Wanneer deze op true (standaard) staat, zal de Device Provisioning Service de gegevens van het apparaat (twin, apparaatmogelijkheden en apparaat-ID) migreren van de ene IoT-hub naar de andere tijdens een IoT-hub toewijzingsupdate. Als deze op false staat, zal de Device Provisioning Service de gegevens van het apparaat terugzetten naar de initiële gewenste configuratie die is opgeslagen in de bijbehorende inschrijvingslijst.
updateHubAssignment	boolean	True	Wanneer deze op true (standaard) staat, zal de Device Provisioning Service de IoT Hub-toewijzing van het apparaat evalueren en deze indien nodig bijwerken voor eventuele provisioningverzoeken die verder gaan dan de eerste van een bepaald apparaat. Als het op false staat, blijft het apparaat toegewezen aan zijn huidige IoT-hub.

SymmetricKeyAttestation

Object

Attestatie via SymmetricKey.

Name	Type	Description
primaryKey	string	Primaire symmetrische sleutel.
secondaryKey	string	Secundaire symmetrische sleutel.

TpmAttestation

Object

Attestatie via TPM.

Name	Type	Description
endorsementKey	string	TPM-endorsement sleutel.
storageRootKey	string	TPM-opslagroot key.

TwinCollection

Object

Vertegenwoordigt een verzameling eigenschappen binnen een Twin

Name	Type	Description
count	integer (int32)	Aantal eigenschappen in de TwinCollection
metadata	Metadata	Metadata voor de TwinCollection
version	integer (int32)	Versie van de TwinCollection

X509Attestation

Object

Bevestiging via X509.

Name	Type	Description
caReferences	X509CAReferences	Primaire en secundaire CA-referenties.
clientCertificates	X509Certificates	Primaire en secundaire certificaten
signingCertificates	X509Certificates	Primaire en secundaire certificaten

X509CAReferences

Object

Primaire en secundaire CA-referenties.

Name	Type	Description
primary	string	Primaire referentie voor CA.
secondary	string	Secundaire CA-referentie.

X509CertificateInfo

Object

X509-certificaatinformatie.

Name	Type	Description
issuerName	string	Naam van de uitgever van het certificaat.
notAfterUtc	string (date-time)	Certificaatgeldigheid beëindigd (UTC).
notBeforeUtc	string (date-time)	Certificaatgeldigheid start (UTC).
serialNumber	string	Serienummer van het certificaat.
sha1Thumbprint	string	SHA-1 duimafdruk van het certificaat.
sha256Thumbprint	string	SHA-256 duimafdruk van het certificaat.
subjectName	string	Onderwerpnaam van het certificaat.
version	integer (int32)	Versie van het certificaat.

X509Certificates

Object

Primaire en secundaire certificaten

Name	Type	Description
primary	X509CertificateWithInfo	Certificaat en certificaatinformatie
secondary	X509CertificateWithInfo	Certificaat en certificaatinformatie

X509CertificateWithInfo

Object

Certificaat en certificaatinformatie

Name	Type	Description
certificate	string	PEM-geformatteerde certificaatstring.
info	X509CertificateInfo	X509-certificaatinformatie.