Enrollment Group - Get

Tjänst:: IoT Hub Device Provisioning Service

API-version:: 2021-10-01

Hämta en enhetsregistreringsgrupp.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
dpsName	path	True	string	DPS-instansens värdnamn.
id	path	True	string	Registreringsgrupp-ID.
api-version	query	True	string minLength: 1	Den API-version som ska användas för den här åtgärden.

Begärandehuvud

Name	Obligatorisk	Typ	Description
Authorization	True	string

Svar

Name	Typ	Description
200 OK	EnrollmentGroup	Begäran har lyckats.
Other Status Codes	ProvisioningServiceErrorDetails	Ett oväntat felsvar. Sidhuvuden x-ms-error-code: string

Name

Typ

Description

200 OK

EnrollmentGroup

Begäran har lyckats.

Other Status Codes

ProvisioningServiceErrorDetails

Ett oväntat felsvar.

Sidhuvuden

x-ms-error-code: string

Säkerhet

Authorization

Typ: apiKey
I: header

Exempel

EnrollmentGroup_Get_MaximumSet_Gen

EnrollmentGroup_Get_MinimumSet_Gen

EnrollmentGroup_Get_MaximumSet_Gen

Exempelbegäran

HTTP

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

Exempelsvar

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

Exempelbegäran

HTTP

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

Exempelsvar

Statuskod:: 200

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

Definitioner

Name	Description
AllocationPolicy	Allokeringspolicyn för denna resurs. Denna policy åsidosätter hyresgästnivåns allokeringspolicy för denna individuella anmälnings- eller anmälningsgrupp. Möjliga värden inkluderar 'hashade': Länkade IoT-hubbar har lika stor sannolikhet enheter som är provisionerade till sig, 'geoLatency': Enheter provisioneras till en IoT-hubb med lägst latens till enheten. Om flera länkade IoT-hubbar ger samma lägsta latens, hashar provisioning-tjänsten enheter över dessa hubbar, 'statisk': Specifikation av önskad IoT-hubb i registreringslistan har företräde framför servicenivåallokeringspolicyn, 'anpassad': Enheter provisioneras till en IoT-hubb baserat på din egen anpassade logik. Provisioneringstjänsten skickar information om enheten till logiken, och logiken returnerar önskad IoT-hubb samt önskad initialkonfiguration. Vi rekommenderar att använda Azure Functions för att hosta din logik.
AttestationMechanism	Attestationsmekanism för individuell registrering samt enrollmentGroup.
AttestationType	Attestationstyp.
CustomAllocationDefinition	Detta talar om för DPS vilken webhook som ska anropas när man använder anpassad allokering.
DeviceCapabilities	Enhetens kapacitet.
EnrollmentGroup	Registreringsgrupp för antagningsgrupper.
InitialTwin	Initial enhetstvilling. Innehåller en delmängd av egenskaperna hos Twin.
InitialTwinProperties	Representerar de initiala egenskaper som kommer att sättas på enhetstvillingen.
Metadata	Metadata för TwinCollection
ProvisioningServiceErrorDetails	Innehåller egenskaperna för ett fel som returneras av Azure IoT Hub Provisioning Service.
ProvisioningStatus	Proviantstatusen.
ReprovisionPolicy	Tjänstens beteende när en enhet återprovisioneras till en IoT-hubb.
SymmetricKeyAttestation	Attestering via SymmetricKey.
TpmAttestation	Intyg via TPM.
TwinCollection	Representerar en samling egenskaper inom en Twin
X509Attestation	Intyg via X509.
X509CAReferences	Primära och sekundära CA-referenser.
X509CertificateInfo	X509-certifikatinformation.
X509Certificates	Primära och sekundära certifikat
X509CertificateWithInfo	Certifikat och certifikatinformation

AllocationPolicy

Uppräkning

Allokeringspolicyn för denna resurs. Denna policy åsidosätter hyresgästnivåns allokeringspolicy för denna individuella anmälnings- eller anmälningsgrupp. Möjliga värden inkluderar 'hashade': Länkade IoT-hubbar har lika stor sannolikhet enheter som är provisionerade till sig, 'geoLatency': Enheter provisioneras till en IoT-hubb med lägst latens till enheten. Om flera länkade IoT-hubbar ger samma lägsta latens, hashar provisioning-tjänsten enheter över dessa hubbar, 'statisk': Specifikation av önskad IoT-hubb i registreringslistan har företräde framför servicenivåallokeringspolicyn, 'anpassad': Enheter provisioneras till en IoT-hubb baserat på din egen anpassade logik. Provisioneringstjänsten skickar information om enheten till logiken, och logiken returnerar önskad IoT-hubb samt önskad initialkonfiguration. Vi rekommenderar att använda Azure Functions för att hosta din logik.

Värde	Description
hashed	Hashade
geoLatency	geoLatens
static	statiskt
custom	anpassad

AttestationMechanism

Objekt

Attestationsmekanism för individuell registrering samt enrollmentGroup.

Name	Typ	Description
symmetricKey	SymmetricKeyAttestation	Symmetrisk nyckelattesteringsmetod.
tpm	TpmAttestation	TPM-attesteringsmetod.
type	AttestationType	Attestationstyp.
x509	X509Attestation	X509-attestationsmetoden.

AttestationType

Uppräkning

Attestationstyp.

Värde	Description
none	none
tpm	Tpm
x509	x509
symmetricKey	symmetricKey

CustomAllocationDefinition

Objekt

Detta talar om för DPS vilken webhook som ska anropas när man använder anpassad allokering.

Name	Typ	Description
apiVersion	string	API-versionen av provisioneringstjänsttyperna (såsom IndividualEnrollment) skickades in i den anpassade allokeringsförfrågan. Minsta stödda version: "2018-09-01-preview".
webhookUrl	string	Webhook-URL:en som används för allokeringsförfrågningar.

DeviceCapabilities

Objekt

Enhetens kapacitet.

Name	Typ	Standardvärde	Description
iotEdge	boolean	False	Om den är satt till true är denna enhet en IoTEdge-enhet.

EnrollmentGroup

Objekt

Registreringsgrupp för antagningsgrupper.

Name	Typ	Standardvärde	Description
allocationPolicy	AllocationPolicy		Allokeringspolicyn för denna resurs. Denna policy åsidosätter hyresgästnivåns allokeringspolicy för denna individuella anmälnings- eller anmälningsgrupp. Möjliga värden inkluderar 'hashade': Länkade IoT-hubbar har lika stor sannolikhet enheter som är provisionerade till sig, 'geoLatency': Enheter provisioneras till en IoT-hubb med lägst latens till enheten. Om flera länkade IoT-hubbar ger samma lägsta latens, hashar provisioning-tjänsten enheter över dessa hubbar, 'statisk': Specifikation av önskad IoT-hubb i registreringslistan har företräde framför servicenivåallokeringspolicyn, 'anpassad': Enheter provisioneras till en IoT-hubb baserat på din egen anpassade logik. Provisioneringstjänsten skickar information om enheten till logiken, och logiken returnerar önskad IoT-hubb samt önskad initialkonfiguration. Vi rekommenderar att använda Azure Functions för att hosta din logik.
attestation	AttestationMechanism		Attesteringsmetod som används av enheten.
capabilities	DeviceCapabilities		Enhetens kapaciteter.
createdDateTimeUtc	string (date-time)		Den här resursen skapades på DateTime.
customAllocationDefinition	CustomAllocationDefinition		Detta talar om för DPS vilken webhook som ska anropas när man använder anpassad allokering.
enrollmentGroupId	string		Registreringsgrupps-ID.
etag	string		Entitetstaggen som är kopplad till resursen.
initialTwin	InitialTwin		Initial enhetstvilling.
iotHubHostName	string		Värdnamnet Iot Hub.
iotHubs	string[]		Listan över IoT Hub-värdnamn som enheten/enheterna i denna resurs kan tilldelas. Det måste vara en delmängd av en hyresgästnivålista över IoT-hubbar.
lastUpdatedDateTimeUtc	string (date-time)		DateTime som denna resurs senast uppdaterades.
provisioningStatus	ProvisioningStatus	enabled	Proviantstatusen.
reprovisionPolicy	ReprovisionPolicy		Beteendet när en enhet återkopplas till en IoT-hubb.

InitialTwin

Objekt

Initial enhetstvilling. Innehåller en delmängd av egenskaperna hos Twin.

Name	Typ	Description
properties	InitialTwinProperties	Önskade egenskaper för tvilling.
tags	TwinCollection	Tvillingtaggar.

InitialTwinProperties

Objekt

Representerar de initiala egenskaper som kommer att sättas på enhetstvillingen.

Name	Typ	Description
desired	TwinCollection	Hämtar och sätter de önskade egenskaperna för InitialTwin.

Metadata

Objekt

Metadata för TwinCollection

Name	Typ	Description
lastUpdated	string (date-time)	Senast uppdaterades TwinCollection
lastUpdatedVersion	integer (int32)	Detta är null för rapporterad egenskapsmetadata och är inte null för önskad egenskapsmetadata.

ProvisioningServiceErrorDetails

Objekt

Innehåller egenskaperna för ett fel som returneras av Azure IoT Hub Provisioning Service.

Name	Typ	Description
errorCode	integer (int32)	Felkod för operationen.
info	object	Ordlista för <sträng>
message	string	Mänskligt läsbart felmeddelande.
timestampUtc	string (date-time)	UTC-tidsstämpeln för felet.
trackingId	string	Spårnings-ID för felet.

ProvisioningStatus

Uppräkning

Proviantstatusen.

Värde	Description
enabled	enabled
disabled	funktionshindrad

ReprovisionPolicy

Objekt

Tjänstens beteende när en enhet återprovisioneras till en IoT-hubb.

Name	Typ	Standardvärde	Description
migrateDeviceData	boolean	True	När den är satt till true (standard) migrerar Device Provisioning Service enhetens data (tvilling, enhetsfunktioner och enhets-ID) från en IoT-hubb till en annan under en IoT-hub-tilldelningsuppdatering. Om den sätts till false kommer Device Provisioning Service att återställa enhetens data till den ursprungliga önskade konfigurationen som lagrats i motsvarande registreringslista.
updateHubAssignment	boolean	True	När den är satt till true (standard) kommer Device Provisioning Service att utvärdera enhetens IoT Hub-tilldelning och uppdatera den vid behov för eventuella provisioneringsförfrågningar utöver den första från en given enhet. Om den är inställd på false kommer enheten att förbli tilldelad sin nuvarande IoT-hubb.

SymmetricKeyAttestation

Objekt

Attestering via SymmetricKey.

Name	Typ	Description
primaryKey	string	Primär symmetrisk nyckel.
secondaryKey	string	Sekundär symmetrisk nyckel.

TpmAttestation

Objekt

Intyg via TPM.

Name	Typ	Description
endorsementKey	string	TPM-godkännandenyckel.
storageRootKey	string	TPM-lagringsrotnyckel.

TwinCollection

Objekt

Representerar en samling egenskaper inom en Twin

Name	Typ	Description
count	integer (int32)	Antal egenskaper i TwinCollection
metadata	Metadata	Metadata för TwinCollection
version	integer (int32)	Version av TwinCollection

X509Attestation

Objekt

Intyg via X509.

Name	Typ	Description
caReferences	X509CAReferences	Primära och sekundära CA-referenser.
clientCertificates	X509Certificates	Primära och sekundära certifikat
signingCertificates	X509Certificates	Primära och sekundära certifikat

X509CAReferences

Objekt

Primära och sekundära CA-referenser.

Name	Typ	Description
primary	string	Primär referens för Kalifornien.
secondary	string	Sekundär referens i Kalifornien.

X509CertificateInfo

Objekt

X509-certifikatinformation.

Name	Typ	Description
issuerName	string	Utgivarens namn på certifikatet.
notAfterUtc	string (date-time)	Giltighetsdatum för certifikat upphört (UTC).
notBeforeUtc	string (date-time)	Giltighetsdatum för certifikat börjar (UTC).
serialNumber	string	Certifikatets serienummer.
sha1Thumbprint	string	SHA-1 tumavtryck av certifikatet.
sha256Thumbprint	string	SHA-256 tumavtryck av certifikatet.
subjectName	string	Certifikatets ämnesnamn.
version	integer (int32)	Version av intyget.

X509Certificates

Objekt

Primära och sekundära certifikat

Name	Typ	Description
primary	X509CertificateWithInfo	Certifikat och certifikatinformation
secondary	X509CertificateWithInfo	Certifikat och certifikatinformation

X509CertificateWithInfo

Objekt

Certifikat och certifikatinformation

Name	Typ	Description
certificate	string	PEM-formaterad certifikatsträng.
info	X509CertificateInfo	X509-certifikatinformation.