Individual Enrollment - Query

Service:

IoT Hub Device Provisioning Service

API-versie:

2021-10-01

Voer een query uit op de registratierecords van het apparaat.

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

URI-parameters

Name	In	Vereist	Type	Description
api-version	query	True	string	De API-versie die moet worden gebruikt voor de aanvraag. Ondersteunde versies zijn onder andere: 2021-10-01

Aanvraagkoptekst

Name	Vereist	Type	Description
x-ms-max-item-count		integer int32	Paginagrootte
x-ms-continuation		string	Vervolgtoken

Aanvraagbody

Name	Vereist	Type	Description
query	True	string

Antwoorden

Name	Type	Description
200 OK	IndividualEnrollment[]	Geslaagd Kopteksten x-ms-continuation: string x-ms-max-item-count: integer x-ms-item-type: string
Other Status Codes	ProvisioningServiceErrorDetails	Foutreactie Kopteksten x-ms-error-code: string

Definities

Name	Description
AttestationMechanism	Attestation-mechanisme voor individualEnrollment en enrollmentGroup.
CustomAllocationDefinition	Dit vertelt DPS welke webhook moet worden aangeroepen bij het gebruik van aangepaste toewijzing.
DeviceCapabilities	Apparaatmogelijkheden.
DeviceRegistrationState	Apparaatregistratiestatus.
IndividualEnrollment	De registratierecord van het apparaat.
InitialTwin	Eerste apparaatdubbel. Bevat een subset van de eigenschappen van Dubbel.
InitialTwinProperties	Vertegenwoordigt de initiële eigenschappen die worden ingesteld op de apparaatdubbel.
Metadata	Metagegevens voor de TwinCollection
ProvisioningServiceErrorDetails	Bevat de eigenschappen van een fout die wordt geretourneerd door de Azure IoT Hub Provisioning Service.
QuerySpecification
ReprovisionPolicy	Het gedrag van de service wanneer een apparaat opnieuw wordt ingericht voor een IoT-hub.
SymmetricKeyAttestation	Attestation via SymmetricKey.
TpmAttestation	Attestation via TPM.
TwinCollection	Vertegenwoordigt een verzameling eigenschappen binnen een dubbel
X509Attestation	Attestation via X509.
X509CAReferences	Primaire en secundaire CA-verwijzingen.
X509CertificateInfo	X509-certificaatgegevens.
X509Certificates	Primaire en secundaire certificaten
X509CertificateWithInfo	Certificaat- en certificaatgegevens

AttestationMechanism

Attestation-mechanisme voor individualEnrollment en enrollmentGroup.

Name	Type	Description
symmetricKey	SymmetricKeyAttestation	Attestation via SymmetricKey.
tpm	TpmAttestation	Attestation via TPM.
type	enum: none symmetricKey tpm x509	Attestation-type.
x509	X509Attestation	Attestation via X509.

CustomAllocationDefinition

Dit vertelt DPS welke webhook moet worden aangeroepen bij het gebruik van aangepaste toewijzing.

Name	Type	Description
apiVersion	string	De API-versie van de inrichtingsservicetypen (zoals IndividualEnrollment) die zijn verzonden in de aangepaste toewijzingsaanvraag. Minimaal ondersteunde versie: "2018-09-01-preview".
webhookUrl	string	De webhook-URL die wordt gebruikt voor toewijzingsaanvragen.

DeviceCapabilities

Apparaatmogelijkheden.

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

DeviceRegistrationState

Apparaatregistratiestatus.

Name	Type	Description
assignedHub	string	Toegewezen Azure IoT Hub.
createdDateTimeUtc	string	De datum voor het maken van de registratie (in UTC).
deviceId	string	Apparaat-id.
errorCode	integer	Foutcode.
errorMessage	string	Foutbericht.
etag	string	De entiteitstag die is gekoppeld aan de resource.
lastUpdatedDateTimeUtc	string	Datum/tijd laatst bijgewerkt (in UTC).
payload	object
registrationId	string	Deze id wordt gebruikt om een apparaatregistratie van een inschrijving uniek te identificeren. Een hoofdlettergevoelige tekenreeks (maximaal 128 tekens lang) met alfanumerieke tekens plus bepaalde speciale tekens: . _ -. Er zijn geen speciale tekens toegestaan aan het begin of einde.
status	enum: assigned assigning disabled failed unassigned	Inschrijvingsstatus.
substatus	enum: deviceDataMigrated deviceDataReset initialAssignment reprovisionedToInitialAssignment	Substatus voor toegewezen apparaten. Mogelijke waarden zijn ' initialAssignment': het apparaat is voor het eerst toegewezen aan een IoT-hub, 'deviceDataMigrated': het apparaat is toegewezen aan een andere IoT-hub en de apparaatgegevens zijn gemigreerd vanuit de eerder toegewezen IoT-hub. Apparaatgegevens zijn verwijderd uit de eerder toegewezen IoT-hub deviceDataReset: het apparaat is toegewezen aan een andere IoT-hub en de apparaatgegevens zijn ingevuld vanaf de initiële status die is opgeslagen in de inschrijving. Apparaatgegevens zijn verwijderd uit de eerder toegewezen IoT-hub, 'reprovisionedToInitialAssignment': het apparaat is opnieuw ingericht voor een eerder toegewezen IoT-hub.

IndividualEnrollment

De registratierecord van het apparaat.

Name	Type	Default value	Description
allocationPolicy	enum: custom geoLatency hashed static		Het toewijzingsbeleid van deze resource. Dit beleid overschrijft het toewijzingsbeleid op tenantniveau voor deze afzonderlijke inschrijving of inschrijvingsgroep. Mogelijke waarden zijn gehasht: gekoppelde IoT-hubs hebben even waarschijnlijk apparaten ingericht, 'geoLatency': apparaten worden ingericht voor een IoT-hub met de laagste latentie voor het apparaat. Als meerdere gekoppelde IoT-hubs dezelfde laagste latentie bieden, hashes de inrichtingsservice apparaten in deze hubs, 'statisch': specificatie van de gewenste IoT-hub in de registratielijst heeft prioriteit boven het toewijzingsbeleid voor serviceniveau, 'aangepast': apparaten worden ingericht voor een IoT-hub op basis van uw eigen aangepaste logica. De inrichtingsservice geeft informatie over het apparaat door aan de logica en de logica retourneert de gewenste IoT-hub en de gewenste initiële configuratie. U wordt aangeraden Azure Functions te gebruiken om uw logica te hosten.
attestation	AttestationMechanism		Attestation-mechanisme voor individualEnrollment en enrollmentGroup.
capabilities	DeviceCapabilities		Apparaatmogelijkheden.
createdDateTimeUtc	string		De Datum/tijd van deze resource is gemaakt.
customAllocationDefinition	CustomAllocationDefinition		Dit vertelt DPS welke webhook moet worden aangeroepen bij het gebruik van aangepaste toewijzing.
deviceId	string		Gewenste IoT Hub apparaat-id (optioneel).
etag	string		De entiteitstag die is gekoppeld aan de resource.
initialTwin	InitialTwin		Eerste apparaatdubbel. Bevat een subset van de eigenschappen van Dubbel.
iotHubHostName	string		De Iot Hub-hostnaam.
iotHubs	string[]		De lijst met IoT Hub hostnamen waaraan de apparaten in deze resource kunnen worden toegewezen. Moet een subset zijn van de lijst met IoT-hubs op tenantniveau.
lastUpdatedDateTimeUtc	string		De Datum/tijd van deze resource is voor het laatst bijgewerkt.
optionalDeviceInformation	TwinCollection		Vertegenwoordigt een verzameling eigenschappen binnen een dubbel
provisioningStatus	enum: disabled enabled	enabled	De inrichtingsstatus.
registrationId	string		Deze id wordt gebruikt om een apparaatregistratie van een inschrijving uniek te identificeren. Een hoofdlettergevoelige tekenreeks (maximaal 128 tekens lang) met alfanumerieke tekens plus bepaalde speciale tekens: . _ -. Er zijn geen speciale tekens toegestaan aan het begin of einde.
registrationState	DeviceRegistrationState		Apparaatregistratiestatus.
reprovisionPolicy	ReprovisionPolicy		Het gedrag van de service wanneer een apparaat opnieuw wordt ingericht voor een IoT-hub.

InitialTwin

Eerste apparaatdubbel. Bevat een subset van de eigenschappen van Dubbel.

Name	Type	Description
properties	InitialTwinProperties	Vertegenwoordigt de initiële eigenschappen die worden ingesteld op de apparaatdubbel.
tags	TwinCollection	Vertegenwoordigt een verzameling eigenschappen binnen een dubbel

InitialTwinProperties

Vertegenwoordigt de initiële eigenschappen die worden ingesteld op de apparaatdubbel.

Name	Type	Description
desired	TwinCollection	Vertegenwoordigt een verzameling eigenschappen binnen een dubbel

Metadata

Metagegevens voor de TwinCollection

Name	Type	Description
lastUpdated	string	De laatste keer dat de TwinCollection is bijgewerkt
lastUpdatedVersion	integer	Dit is null voor metagegevens van gerapporteerde eigenschappen en is niet null voor metagegevens van gewenste eigenschappen.

ProvisioningServiceErrorDetails

Bevat de eigenschappen van een fout die wordt geretourneerd door de Azure IoT Hub Provisioning Service.

Name	Type	Description
errorCode	integer
info	object
message	string
timestampUtc	string
trackingId	string

QuerySpecification

Name	Type	Description
query	string

ReprovisionPolicy

Het gedrag van de service wanneer een apparaat opnieuw wordt ingericht voor een IoT-hub.

Name	Type	Default value	Description
migrateDeviceData	boolean	True	Als deze optie is ingesteld op true (standaard), migreert Device Provisioning Service de gegevens van het apparaat (dubbel, apparaatmogelijkheden en apparaat-id) van de ene IoT-hub naar de andere tijdens een update van een IoT-hubtoewijzing. Als deze optie is ingesteld op onwaar, stelt Device Provisioning Service de gegevens van het apparaat opnieuw in op de oorspronkelijke gewenste configuratie die is opgeslagen in de bijbehorende inschrijvingslijst.
updateHubAssignment	boolean	True	Als deze optie is ingesteld op true (standaard), evalueert Device Provisioning Service de IoT Hub-toewijzing van het apparaat en werkt deze zo nodig bij voor inrichtingsaanvragen die verder gaan dan de eerste van een bepaald apparaat. Als dit is ingesteld op false, blijft het apparaat toegewezen aan de huidige IoT-hub.

SymmetricKeyAttestation

Attestation via SymmetricKey.

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

TpmAttestation

Attestation via TPM.

Name	Type	Description
endorsementKey	string
storageRootKey	string

TwinCollection

Vertegenwoordigt een verzameling eigenschappen binnen een dubbel

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

X509Attestation

Attestation via X509.

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

X509CAReferences

Primaire en secundaire CA-verwijzingen.

Name	Type	Description
primary	string
secondary	string

X509CertificateInfo

X509-certificaatgegevens.

Name	Type	Description
issuerName	string
notAfterUtc	string
notBeforeUtc	string
serialNumber	string
sha1Thumbprint	string
sha256Thumbprint	string
subjectName	string
version	integer

X509Certificates

Primaire en secundaire certificaten

Name	Type	Description
primary	X509CertificateWithInfo	Certificaat- en certificaatgegevens
secondary	X509CertificateWithInfo	Certificaat- en certificaatgegevens

X509CertificateWithInfo

Certificaat- en certificaatgegevens

Name	Type	Description
certificate	string
info	X509CertificateInfo	X509-certificaatgegevens.