Individual Enrollment - Create Or Update

Usługa:

IoT Hub Device Provisioning Service

Wersja interfejsu API:

2021-10-01

Twórca lub zaktualizuj rekord rejestracji urządzenia.

PUT https://your-dps.azure-devices-provisioning.net/enrollments/{id}?api-version=2021-10-01

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
id	path	True	string	Ten identyfikator służy do unikatowego identyfikowania rejestracji urządzenia w ramach rejestracji. Ciąg bez uwzględniania wielkości liter (maksymalnie 128 znaków) znaków alfanumerycznych oraz niektóre znaki specjalne: . _ -. Brak znaków specjalnych dozwolonych na początku lub na końcu.
api-version	query	True	string	Wersja interfejsu API do użycia dla żądania. Obsługiwane wersje to: 2021-10-01

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
If-Match		string	Element ETag rekordu rejestracji.

Treść żądania

Nazwa	Wymagane	Typ	Opis
attestation	True	AttestationMechanism	Mechanizm zaświadczania dla poszczególnych Rejestracji, a także enrollmentGroup.
registrationId	True	string	Ten identyfikator służy do unikatowego identyfikowania rejestracji urządzenia. Ciąg bez uwzględniania wielkości liter (do 128 znaków) znaków alfanumerycznych oraz niektóre znaki specjalne: . _ -. Bez znaków specjalnych dozwolonych na początku lub na końcu.
allocationPolicy		enum: hashed geoLatency static custom	Zasady alokacji tego zasobu. Te zasady zastępują zasady alokacji na poziomie dzierżawy dla tej indywidualnej rejestracji lub grupy rejestracji. Możliwe wartości obejmują "skrót": połączone centra IoT są równie prawdopodobne, że urządzenia mają aprowidowane urządzenia, "geoLatency": urządzenia są aprowidowane w centrum IoT z najniższym opóźnieniem dla urządzenia. Jeśli wiele połączonych centrów IoT będzie zapewniać takie samo najmniejsze opóźnienie, urządzenia skrótów usługi aprowizacji w tych centrach, "statyczne": specyfikacja żądanego centrum IoT na liście rejestracji ma priorytet nad zasadami alokacji na poziomie usługi, "niestandardowe": urządzenia są aprowidowane w centrum IoT na podstawie własnej logiki niestandardowej. Usługa aprowizacji przekazuje informacje o urządzeniu do logiki, a logika zwraca żądane centrum IoT Oraz żądaną konfigurację początkową. Zalecamy używanie Azure Functions do hostowania logiki.
capabilities		DeviceCapabilities	Możliwości urządzenia.
customAllocationDefinition		CustomAllocationDefinition	Informuje to usługę DPS o tym, który element webhook ma być wywoływany podczas korzystania z alokacji niestandardowej.
deviceId		string	Żądany identyfikator urządzenia IoT Hub (opcjonalnie).
etag		string	Tag jednostki skojarzony z zasobem.
initialTwin		InitialTwin	Początkowa reprezentacja urządzenia. Zawiera podzbiór właściwości bliźniaczej reprezentacji.
iotHubHostName		string	Nazwa hosta usługi Iot Hub.
iotHubs		string[]	Lista IoT Hub nazw hostów, do których można przydzielić urządzenia w tym zasobie. Musi być podzbiorem listy poziomów dzierżawy centrów IoT.
optionalDeviceInformation		TwinCollection	Reprezentuje kolekcję właściwości w ramach bliźniaczej reprezentacji
provisioningStatus		enum: enabled disabled	Stan aprowizacji.
registrationState		DeviceRegistrationState	Stan rejestracji urządzenia.
reprovisionPolicy		ReprovisionPolicy	Zachowanie usługi w przypadku ponownego aprowizowania urządzenia w centrum IoT Hub.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	IndividualEnrollment	Powodzenie
Other Status Codes	ProvisioningServiceErrorDetails	Odpowiedź na błąd Nagłówki x-ms-error-code: string

Definicje

Nazwa	Opis
AttestationMechanism	Mechanizm zaświadczania dla poszczególnych Rejestracji, a także enrollmentGroup.
CustomAllocationDefinition	Informuje to usługę DPS, która element webhook ma być wywoływana podczas korzystania z alokacji niestandardowej.
DeviceCapabilities	Możliwości urządzenia.
DeviceRegistrationState	Stan rejestracji urządzenia.
IndividualEnrollment	Rekord rejestracji urządzenia.
InitialTwin	Początkowa reprezentacja urządzenia. Zawiera podzbiór właściwości bliźniaczej reprezentacji.
InitialTwinProperties	Reprezentuje właściwości początkowe, które zostaną ustawione na bliźniaczej reprezentacji urządzenia.
Metadata	Metadane bliźniaczej kolekcji TwinCollection
ProvisioningServiceErrorDetails	Zawiera właściwości błędu zwróconego przez usługę Azure IoT Hub Provisioning Service.
ReprovisionPolicy	Zachowanie usługi po ponownym aprowizacji urządzenia w centrum IoT.
SymmetricKeyAttestation	Zaświadczania za pomocą klawisza SymmetricKey.
TpmAttestation	Zaświadczenie za pośrednictwem modułu TPM.
TwinCollection	Reprezentuje kolekcję właściwości w ramach bliźniaczej reprezentacji
X509Attestation	Zaświadczania za pośrednictwem X509.
X509CAReferences	Odwołania do podstawowego i pomocniczego urzędu certyfikacji.
X509CertificateInfo	Informacje o certyfikacie X509.
X509Certificates	Certyfikaty podstawowe i pomocnicze
X509CertificateWithInfo	Informacje o certyfikacie i certyfikacie

AttestationMechanism

Mechanizm zaświadczania dla poszczególnych Rejestracji, a także enrollmentGroup.

Nazwa	Typ	Opis
symmetricKey	SymmetricKeyAttestation	Zaświadczania za pomocą klawisza SymmetricKey.
tpm	TpmAttestation	Zaświadczenie za pośrednictwem modułu TPM.
type	enum: none symmetricKey tpm x509	Typ zaświadczania.
x509	X509Attestation	Zaświadczania za pośrednictwem X509.

CustomAllocationDefinition

Informuje to usługę DPS, która element webhook ma być wywoływana podczas korzystania z alokacji niestandardowej.

Nazwa	Typ	Opis
apiVersion	string	Wersja interfejsu API typów usługi aprowizacji (takich jak IndividualEnrollment) wysłanych w niestandardowym żądaniu alokacji. Minimalna obsługiwana wersja: "2018-09-01-preview".
webhookUrl	string	Adres URL elementu webhook używany do żądań alokacji.

DeviceCapabilities

Możliwości urządzenia.

Nazwa	Typ	Domyślna wartość	Opis
iotEdge	boolean	False	Jeśli jest ustawiona wartość true, to urządzenie jest urządzeniem IoTEdge.

DeviceRegistrationState

Stan rejestracji urządzenia.

Nazwa	Typ	Opis
assignedHub	string	Przypisane Azure IoT Hub.
createdDateTimeUtc	string	Rejestracja utwórz datę i godzinę (w formacie UTC).
deviceId	string	Identyfikator urządzenia.
errorCode	integer	Kod błędu.
errorMessage	string	Komunikat o błędzie.
etag	string	Tag jednostki skojarzony z zasobem.
lastUpdatedDateTimeUtc	string	Data ostatniej aktualizacji (w formacie UTC).
payload	object
registrationId	string	Ten identyfikator służy do unikatowego identyfikowania rejestracji urządzenia. Ciąg bez uwzględniania wielkości liter (do 128 znaków) znaków alfanumerycznych oraz niektóre znaki specjalne: . _ -. Bez znaków specjalnych dozwolonych na początku lub na końcu.
status	enum: assigned assigning disabled failed unassigned	Stan rejestracji.
substatus	enum: deviceDataMigrated deviceDataReset initialAssignment reprovisionedToInitialAssignment	Podstatu dla urządzeń przypisanych. Możliwe wartości to : "initialAssignment": Urządzenie zostało przypisane do centrum IoT po raz pierwszy "deviceDataMigrated": urządzenie zostało przypisane do innego centrum IoT, a jego dane urządzenia zostały zmigrowane z wcześniej przypisanego centrum IoT. Dane urządzenia zostały usunięte z wcześniej przypisanego centrum IoT Hub "deviceDataReset": urządzenie zostało przypisane do innego centrum IoT, a jego dane urządzenia zostały wypełnione ze stanu początkowego przechowywanego w rejestracji. Dane urządzenia zostały usunięte z wcześniej przypisanego centrum IoT Hub "reprovisionedToInitialAssignment": urządzenie zostało ponownie aprowizacji do wcześniej przypisanego centrum IoT.

IndividualEnrollment

Rekord rejestracji urządzenia.

Nazwa	Typ	Domyślna wartość	Opis
allocationPolicy	enum: custom geoLatency hashed static		Zasady alokacji tego zasobu. Te zasady zastępują zasady alokacji na poziomie dzierżawy dla tej indywidualnej rejestracji lub grupy rejestracji. Możliwe wartości obejmują "skrót": połączone centra IoT są równie prawdopodobne, że urządzenia są aprowizowane do nich, "geoLatency": urządzenia są aprowizowane w centrum IoT z najniższym opóźnieniem dla urządzenia. Jeśli wiele połączonych centrów IoT zapewni takie samo najmniejsze opóźnienie, urządzenia skrótów usługi aprowizacji w tych centrach, "statyczne" : specyfikacja żądanego centrum IoT na liście rejestracji ma priorytet nad zasadami alokacji na poziomie usługi, "niestandardowe": urządzenia są aprowizowane w centrum IoT na podstawie własnej logiki niestandardowej. Usługa aprowizacji przekazuje informacje o urządzeniu do logiki, a logika zwraca żądane centrum IoT, a także żądaną konfigurację początkową. Zalecamy używanie Azure Functions do hostowania logiki.
attestation	AttestationMechanism		Mechanizm zaświadczania dla poszczególnych Rejestracji, a także enrollmentGroup.
capabilities	DeviceCapabilities		Możliwości urządzenia.
createdDateTimeUtc	string		Data/godzina utworzenia tego zasobu.
customAllocationDefinition	CustomAllocationDefinition		Informuje to usługę DPS, która element webhook ma być wywoływana podczas korzystania z alokacji niestandardowej.
deviceId	string		Żądany identyfikator urządzenia IoT Hub (opcjonalnie).
etag	string		Tag jednostki skojarzony z zasobem.
initialTwin	InitialTwin		Początkowa reprezentacja urządzenia. Zawiera podzbiór właściwości bliźniaczej reprezentacji.
iotHubHostName	string		Nazwa hosta usługi Iot Hub.
iotHubs	string[]		Lista IoT Hub nazw hostów, do których można przydzielić urządzenia w tym zasobie. Musi być podzbiorem listy poziomów dzierżawy centrów IoT.
lastUpdatedDateTimeUtc	string		Data/godzina ostatniej aktualizacji tego zasobu.
optionalDeviceInformation	TwinCollection		Reprezentuje kolekcję właściwości w ramach bliźniaczej reprezentacji
provisioningStatus	enum: disabled enabled	enabled	Stan aprowizacji.
registrationId	string		Ten identyfikator służy do unikatowego identyfikowania rejestracji urządzenia. Ciąg bez uwzględniania wielkości liter (do 128 znaków) znaków alfanumerycznych oraz niektóre znaki specjalne: . _ -. Bez znaków specjalnych dozwolonych na początku lub na końcu.
registrationState	DeviceRegistrationState		Stan rejestracji urządzenia.
reprovisionPolicy	ReprovisionPolicy		Zachowanie usługi po ponownym aprowizacji urządzenia w centrum IoT.

InitialTwin

Początkowa reprezentacja urządzenia. Zawiera podzbiór właściwości bliźniaczej reprezentacji.

Nazwa	Typ	Opis
properties	InitialTwinProperties	Reprezentuje właściwości początkowe, które zostaną ustawione na bliźniaczej reprezentacji urządzenia.
tags	TwinCollection	Reprezentuje kolekcję właściwości w ramach bliźniaczej reprezentacji

InitialTwinProperties

Reprezentuje właściwości początkowe, które zostaną ustawione na bliźniaczej reprezentacji urządzenia.

Nazwa	Typ	Opis
desired	TwinCollection	Reprezentuje kolekcję właściwości w ramach bliźniaczej reprezentacji

Metadata

Metadane bliźniaczej kolekcji TwinCollection

Nazwa	Typ	Opis
lastUpdated	string	Czas ostatniej aktualizacji elementu TwinCollection
lastUpdatedVersion	integer	Jest to wartość null dla metadanych zgłoszonych właściwości i nie ma wartości null dla żądanych metadanych właściwości.

ProvisioningServiceErrorDetails

Zawiera właściwości błędu zwróconego przez usługę Azure IoT Hub Provisioning Service.

Nazwa	Typ	Opis
errorCode	integer
info	object
message	string
timestampUtc	string
trackingId	string

ReprovisionPolicy

Zachowanie usługi po ponownym aprowizacji urządzenia w centrum IoT.

Nazwa	Typ	Domyślna wartość	Opis
migrateDeviceData	boolean	True	Po ustawieniu wartości true (wartość domyślna) usługa Device Provisioning przeprowadzi migrację danych urządzenia (bliźniaczej reprezentacji, możliwości urządzenia i identyfikatora urządzenia) z jednego centrum IoT do innego podczas aktualizacji przypisania centrum IoT. Jeśli ustawiono wartość false, usługa Device Provisioning Service zresetuje dane urządzenia do początkowej żądanej konfiguracji przechowywanej na odpowiedniej liście rejestracji.
updateHubAssignment	boolean	True	Po ustawieniu wartości true (wartość domyślna) usługa Device Provisioning oceni przypisanie IoT Hub urządzenia i zaktualizuje je w razie potrzeby w przypadku żądań aprowizacji wykraczających poza pierwsze z danego urządzenia. Jeśli ustawienie ma wartość false, urządzenie pozostanie przypisane do bieżącego centrum IoT.

SymmetricKeyAttestation

Zaświadczania za pomocą klawisza SymmetricKey.

Nazwa	Typ	Opis
primaryKey	string	Podstawowy klucz symetryczny.
secondaryKey	string	Pomocniczy klucz symetryczny.

TpmAttestation

Zaświadczenie za pośrednictwem modułu TPM.

Nazwa	Typ	Opis
endorsementKey	string
storageRootKey	string

TwinCollection

Reprezentuje kolekcję właściwości w ramach bliźniaczej reprezentacji

Nazwa	Typ	Opis
count	integer	Liczba właściwości w kolekcji TwinCollection
metadata	Metadata	Metadane bliźniaczej kolekcji TwinCollection
version	integer	Wersja elementu TwinCollection

X509Attestation

Zaświadczania za pośrednictwem X509.

Nazwa	Typ	Opis
caReferences	X509CAReferences	Odwołania do podstawowego i pomocniczego urzędu certyfikacji.
clientCertificates	X509Certificates	Certyfikaty podstawowe i pomocnicze
signingCertificates	X509Certificates	Certyfikaty podstawowe i pomocnicze

X509CAReferences

Odwołania do podstawowego i pomocniczego urzędu certyfikacji.

Nazwa	Typ	Opis
primary	string
secondary	string

X509CertificateInfo

Informacje o certyfikacie X509.

Nazwa	Typ	Opis
issuerName	string
notAfterUtc	string
notBeforeUtc	string
serialNumber	string
sha1Thumbprint	string
sha256Thumbprint	string
subjectName	string
version	integer

X509Certificates

Certyfikaty podstawowe i pomocnicze

Nazwa	Typ	Opis
primary	X509CertificateWithInfo	Informacje o certyfikacie i certyfikacie
secondary	X509CertificateWithInfo	Informacje o certyfikacie i certyfikacie

X509CertificateWithInfo

Informacje o certyfikacie i certyfikacie

Nazwa	Typ	Opis
certificate	string
info	X509CertificateInfo	Informacje o certyfikacie X509.