Runtime Registration - Register Device

Service:

IoT Hub Device Provisioning Service

API-versie:

2021-10-01

Registreert de apparaten.

PUT https://global.azure-devices-provisioning.net/{idScope}/registrations/{registrationId}/register?api-version=2021-10-01

URI-parameters

Name	In	Vereist	Type	Description
idScope	path	True	string
registrationId	path	True	string	De registratie-id is alfanumeriek, kleine letters en kan afbreekstreepjes bevatten.
api-version	query	True	string	De API-versie die moet worden gebruikt voor de aanvraag. Ondersteunde versies zijn: 2021-10-01

Aanvraagbody

Name	Type	Description
payload	object
registrationId	string	De registratie-id is een niet-hoofdlettergevoelige tekenreeks (maximaal 128 tekens lang) met alfanumerieke tekens plus bepaalde speciale tekens: . _ -. Er zijn geen speciale tekens toegestaan aan het begin of einde.
tpm	TpmAttestation	Attestation via TPM.

Antwoorden

Name	Type	Description
200 OK	RegistrationOperationStatus	Geslaagd
202 Accepted	RegistrationOperationStatus	Geaccepteerd Kopteksten Location: string retry-after: integer
Other Status Codes	ProvisioningServiceErrorDetails	Foutreactie Kopteksten x-ms-error-code: string

Definities

Name	Description
DeviceRegistration	Apparaatregistratie.
DeviceRegistrationResult	Resultaat van apparaatregistratie.
ProvisioningServiceErrorDetails	Bevat de eigenschappen van een fout die is geretourneerd door de Azure IoT Hub Provisioning Service.
RegistrationOperationStatus	Status van registratiebewerking.
SymmetricKeyRegistrationResult	Het registratieresultaat dat wordt geretourneerd bij het gebruik van SymmetricKey-attestation.
TpmAttestation	Attestation via TPM.
TpmRegistrationResult	RESULTAAT VAN TPM-registratie.
X509CertificateInfo	X509-certificaatgegevens.
X509RegistrationResult	X509-registratieresultaat.

DeviceRegistration

Apparaatregistratie.

Name	Type	Description
payload	object
registrationId	string	De registratie-id is een niet-hoofdlettergevoelige tekenreeks (maximaal 128 tekens lang) met alfanumerieke tekens plus bepaalde speciale tekens: . _ -. Er zijn geen speciale tekens toegestaan aan het begin of einde.
tpm	TpmAttestation	Attestation via TPM.

DeviceRegistrationResult

Resultaat van apparaatregistratie.

Name	Type	Description
assignedHub	string	Toegewezen Azure IoT Hub.
createdDateTimeUtc	string	Datum van registratie maken (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 oorspronkelijke 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.
symmetricKey	SymmetricKeyRegistrationResult	Het registratieresultaat dat wordt geretourneerd bij het gebruik van SymmetricKey-attestation.
tpm	TpmRegistrationResult	RESULTAAT VAN TPM-registratie.
x509	X509RegistrationResult	X509-registratieresultaat.

ProvisioningServiceErrorDetails

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

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

RegistrationOperationStatus

Status van registratiebewerking.

Name	Type	Description
operationId	string	Bewerkings-id.
registrationState	DeviceRegistrationResult	Resultaat van apparaatregistratie.
status	enum: assigned assigning disabled failed unassigned	Status van apparaatinschrijving.

SymmetricKeyRegistrationResult

Het registratieresultaat dat wordt geretourneerd bij het gebruik van SymmetricKey-attestation.

Name	Type	Description
enrollmentGroupId	string

TpmAttestation

Attestation via TPM.

Name	Type	Description
endorsementKey	string
storageRootKey	string

TpmRegistrationResult

RESULTAAT VAN TPM-registratie.

Name	Type	Description
authenticationKey	string	Versleutelde verificatiesleutel.

X509CertificateInfo

X509-certificaatgegevens.

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

X509RegistrationResult

X509-registratieresultaat.

Name	Type	Description
certificateInfo	X509CertificateInfo	X509-certificaatgegevens.
enrollmentGroupId	string
signingCertificateInfo	X509CertificateInfo	X509-certificaatgegevens.