Udostępnij za pośrednictwem

Individual Enrollment - Run Bulk Operation

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

Zbiorcza operacja rejestracji urządzeń z maksymalnie 10 rejestracjami.

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
api-version
 query True

string

Wersja interfejsu API do użycia dla żądania. Obsługiwane wersje to: 2021-10-01

Treść żądania

Nazwa Wymagane Typ Opis
enrollments True

IndividualEnrollment[]

Elementy rejestracji
mode True enum:
  • create
  • update
  • updateIfMatchETag
  • delete

Tryb działania.

Odpowiedzi

Nazwa Typ Opis
200 OK

BulkEnrollmentOperationResult

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.
BulkEnrollmentOperation

Operacja rejestracji zbiorczej.
BulkEnrollmentOperationError

Błąd operacji rejestracji zbiorczej
BulkEnrollmentOperationResult

Wyniki operacji rejestracji zbiorczej
CustomAllocationDefinition

Informuje to usługę DPS o tym, który element webhook ma być wywoływany 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 dla 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 ponownego aprowizowania urządzenia w centrum IoT Hub.
SymmetricKeyAttestation

Zaświadczenie za pomocą klucza symetrycznego.
TpmAttestation

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

Reprezentuje kolekcję właściwości w obrębie 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

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

Nazwa Typ Opis
symmetricKey

SymmetricKeyAttestation

Zaświadczenie za pomocą klucza symetrycznego.
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.

BulkEnrollmentOperation

Operacja rejestracji zbiorczej.

Nazwa Typ Opis
enrollments

IndividualEnrollment[]

Elementy rejestracji
mode enum:
  • create
  • delete
  • update
  • updateIfMatchETag

Tryb działania.

BulkEnrollmentOperationError

Błąd operacji rejestracji zbiorczej

Nazwa Typ Opis
errorCode

integer

Kod błędu
errorStatus

string

Stan błędu.
registrationId

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.

BulkEnrollmentOperationResult

Wyniki operacji rejestracji zbiorczej

Nazwa Typ Opis
errors

BulkEnrollmentOperationError[]

Błędy rejestracji
isSuccessful

boolean

Wskazuje, czy operacja zakończyła się pomyślnie w całości.

CustomAllocationDefinition

Informuje to usługę DPS o tym, który element webhook ma być wywoływany 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 tworzy 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 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.
status enum:
  • assigned
  • assigning
  • disabled
  • failed
  • unassigned

Stan rejestracji.
substatus enum:
  • deviceDataMigrated
  • deviceDataReset
  • initialAssignment
  • reprovisionedToInitialAssignment

Stan podrzędny 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 aprowidowane 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 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.
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 o tym, który element webhook ma być wywoływany podczas korzystania z alokacji niestandardowej.
deviceId

string

Żądany IoT Hub identyfikator urządzenia (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 obrębie bliźniaczej reprezentacji
provisioningStatus enum:
  • disabled
  • enabled
enabled

Stan aprowizacji.
registrationId

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.
registrationState

DeviceRegistrationState

Stan rejestracji urządzenia.
reprovisionPolicy

ReprovisionPolicy

Zachowanie usługi w przypadku ponownego aprowizowania urządzenia w centrum IoT Hub.

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

Metadata

Metadane dla kolekcji TwinCollection

Nazwa Typ Opis
lastUpdated

string

Czas ostatniej aktualizacji kolekcji TwinCollection
lastUpdatedVersion

integer

Jest to wartość null dla metadanych zgłoszonych właściwości i nie ma wartości null dla metadanych żądanych 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 w przypadku ponownego aprowizowania 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 zmigruje dane urządzenia (bliźniacze reprezentacje, możliwości urządzeń i identyfikator urządzenia) z jednego centrum IoT do drugiego 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 IoT Hub urządzenia i zaktualizuje je w razie potrzeby w przypadku żądań aprowizacji poza pierwszym z danego urządzenia. Jeśli zostanie ustawiona wartość false, urządzenie pozostanie przypisane do bieżącego centrum IoT.

SymmetricKeyAttestation

Zaświadczenie za pomocą klucza symetrycznego.

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

Nazwa Typ Opis
count

integer

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

Metadata

Metadane dla kolekcji TwinCollection
version

integer

Wersja kolekcji TwinCollection

X509Attestation

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

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.