Udostępnij przez

Individual Enrollment - Create Or Update

Usługa:
IoT Hub Device Provisioning Service
Wersja interfejsu API:
2021-10-01

Utwórz 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 (do 128 znaków) znaków alfanumerycznych oraz niektóre znaki specjalne: . _ -. Bez 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

minLength: 1

Ten identyfikator służy do unikatowego identyfikowania rejestracji urządzenia w ramach rejestracji. 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 mają równie duże prawdopodobieństwo aprowizacji urządzeń: geoLatency: urządzenia są aprowidowane 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 hostowanie logiki przy użyciu usługi Azure Functions.
capabilities

DeviceCapabilities

Możliwości urządzenia.
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 usługi 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 bliźniaczej.
iotHubHostName

string

Nazwa hosta usługi Iot Hub.
iotHubs

string[]

Lista hostów usługi IoT Hub umożliwia przydzielenie urządzeń w tym zasobie. Musi być podzbiorem listy poziomów dzierżawy centrów IoT.
optionalDeviceInformation

TwinCollection

Reprezentuje kolekcję właściwości w bliźniaczej reprezentacji
provisioningStatus enum:
  • enabled
  • disabled

Stan aprowizacji.
registrationState

DeviceRegistrationState

Stan rejestracji urządzenia.
reprovisionPolicy

ReprovisionPolicy

Zachowanie usługi w przypadku ponownej aprowizacji 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 bliźniaczej.
InitialTwinProperties

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

Metadane kolekcji TwinCollection
ProvisioningServiceErrorDetails

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

Zachowanie usługi w przypadku ponownej aprowizacji urządzenia w centrum IoT Hub.
SymmetricKeyAttestation

Zaświadczenie za pomocą klucza SymmetricKey.
TpmAttestation

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

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

Zaświadczenie 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

Objekt

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

Nazwa Typ Opis
symmetricKey

SymmetricKeyAttestation

Zaświadczenie za pomocą klucza SymmetricKey.
tpm

TpmAttestation

Zaświadczenie za pośrednictwem modułu TPM.
type enum:
  • none
  • symmetricKey
  • tpm
  • x509

Typ zaświadczania.
x509

X509Attestation

Zaświadczenie za pośrednictwem X509.

CustomAllocationDefinition

Objekt

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

Nazwa Typ Opis
apiVersion

string

minLength: 1

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

minLength: 1

Adres URL elementu webhook używany do żądań alokacji.

DeviceCapabilities

Objekt

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

Objekt

Stan rejestracji urządzenia.

Nazwa Typ Opis
assignedHub

string

Przypisano usługę Azure IoT Hub.
createdDateTimeUtc

string (date-time)

Rejestracja tworzy datę i godzinę (w formacie UTC).
deviceId

string

Identyfikator urządzenia.
errorCode

integer (int32)

Kod błędu.
errorMessage

string

Komunikat o błędzie.
etag

string

Tag jednostki skojarzony z zasobem.
lastUpdatedDateTimeUtc

string (date-time)

Data ostatniej aktualizacji (w formacie UTC).
payload

object

registrationId

string

Ten identyfikator służy do unikatowego identyfikowania rejestracji urządzenia w ramach rejestracji. 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

Podstatuj 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 "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 aprowidowane do wcześniej przypisanego centrum IoT.

IndividualEnrollment

Objekt

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 mają równie duże prawdopodobieństwo aprowizacji urządzeń: geoLatency: urządzenia są aprowidowane 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 hostowanie logiki przy użyciu usługi Azure Functions.
attestation

AttestationMechanism

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

DeviceCapabilities

Możliwości urządzenia.
createdDateTimeUtc

string (date-time)

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 usługi 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 bliźniaczej.
iotHubHostName

string

Nazwa hosta usługi Iot Hub.
iotHubs

string[]

Lista hostów usługi IoT Hub umożliwia przydzielenie urządzeń w tym zasobie. Musi być podzbiorem listy poziomów dzierżawy centrów IoT.
lastUpdatedDateTimeUtc

string (date-time)

Data/godzina ostatniej aktualizacji tego zasobu.
optionalDeviceInformation

TwinCollection

Reprezentuje kolekcję właściwości w bliźniaczej reprezentacji
provisioningStatus enum:
  • disabled
  • enabled
enabled

Stan aprowizacji.
registrationId

string

minLength: 1

Ten identyfikator służy do unikatowego identyfikowania rejestracji urządzenia w ramach rejestracji. 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 w przypadku ponownej aprowizacji urządzenia w centrum IoT Hub.

InitialTwin

Objekt

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

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 bliźniaczej reprezentacji

InitialTwinProperties

Objekt

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 bliźniaczej reprezentacji

Metadata

Objekt

Metadane kolekcji TwinCollection

Nazwa Typ Opis
lastUpdated

string (date-time)

Czas ostatniej aktualizacji elementu TwinCollection
lastUpdatedVersion

integer (int64)

Jest to wartość null dla zgłoszonych metadanych właściwości i nie ma wartości null dla żądanych metadanych właściwości.

ProvisioningServiceErrorDetails

Objekt

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

Nazwa Typ Opis
errorCode

integer (int32)

info

object

message

string

timestampUtc

string (date-time)

trackingId

string

ReprovisionPolicy

Objekt

Zachowanie usługi w przypadku ponownej aprowizacji urządzenia w centrum IoT Hub.

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. W przypadku ustawienia wartości false usługa Device Provisioning 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 Service oceni przypisanie usługi IoT Hub urządzenia i zaktualizuje je, jeśli jest to konieczne, aby żądania aprowizacji wykraczały poza pierwsze z danego urządzenia. Jeśli zostanie ustawiona wartość false, urządzenie pozostanie przypisane do bieżącego centrum IoT.

SymmetricKeyAttestation

Objekt

Zaświadczenie za pomocą klucza SymmetricKey.

Nazwa Typ Opis
primaryKey

string

Podstawowy klucz symetryczny.
secondaryKey

string

Pomocniczy klucz symetryczny.

TpmAttestation

Objekt

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

Nazwa Typ Opis
endorsementKey

string

storageRootKey

string

TwinCollection

Objekt

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

Nazwa Typ Opis
count

integer

Liczba właściwości w kolekcji TwinCollection
metadata

Metadata

Metadane kolekcji TwinCollection
version

integer (int64)

Wersja kolekcji TwinCollection

X509Attestation

Objekt

Zaświadczenie 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

Objekt

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

Nazwa Typ Opis
primary

string

secondary

string

X509CertificateInfo

Objekt

Informacje o certyfikacie X509.

Nazwa Typ Opis
issuerName

string

notAfterUtc

string (date-time)

notBeforeUtc

string (date-time)

serialNumber

string

sha1Thumbprint

string

sha256Thumbprint

string

subjectName

string

version

integer (int32)

X509Certificates

Objekt

Certyfikaty podstawowe i pomocnicze

Nazwa Typ Opis
primary

X509CertificateWithInfo

Informacje o certyfikacie i certyfikacie
secondary

X509CertificateWithInfo

Informacje o certyfikacie i certyfikacie

X509CertificateWithInfo

Objekt

Informacje o certyfikacie i certyfikacie

Nazwa Typ Opis
certificate

string

info

X509CertificateInfo

Informacje o certyfikacie X509.