Udostępnij za pośrednictwem

Device Registration State - Query

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

Pobiera stan rejestracji urządzeń w tej grupie rejestracji.

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
id
 path True

string

Identyfikator grupy rejestracji.
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
x-ms-max-item-count

integer

int32

Pagesize
x-ms-continuation

string

token kontynuacji

Odpowiedzi

Nazwa Typ Opis
200 OK

DeviceRegistrationState[]

Powodzenie

Nagłówki

  • x-ms-continuation: string
  • x-ms-max-item-count: integer
  • x-ms-item-type: string
Other Status Codes

ProvisioningServiceErrorDetails

Odpowiedź na błąd

Nagłówki

x-ms-error-code: string

Definicje

Nazwa Opis
DeviceRegistrationState

Stan rejestracji urządzenia.
ProvisioningServiceErrorDetails

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

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.

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