Devices - Create Or Update Identity

Usługa:

IoT Hub

Wersja interfejsu API:

2021-04-12

Tworzy lub aktualizuje tożsamość urządzenia w rejestrze tożsamości IoT Hub.

PUT https://fully-qualified-iothubname.azure-devices.net/devices/{id}?api-version=2021-04-12

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
id	path	True	string	Unikatowy identyfikator urządzenia.
api-version	query	True	string	Wersja interfejsu API.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
If-Match		string	Ciąg reprezentujący słaby element ETag dla tożsamości urządzenia zgodnie z RFC7232. Nie należy go ustawiać podczas tworzenia urządzenia, ale można go ustawić podczas aktualizowania urządzenia.

Treść żądania

Nazwa	Typ	Opis
authentication	AuthenticationMechanism	Mechanizm uwierzytelniania używany przez urządzenie.
capabilities	DeviceCapabilities	Zestaw możliwości urządzenia. Jeśli na przykład to urządzenie jest urządzeniem brzegowym, czy nie.
cloudToDeviceMessageCount	integer	Liczba komunikatów przesyłanych z chmury do urządzenia, które mają być obecnie wysyłane do urządzenia.
connectionState	enum: Disconnected Connected	Stan urządzenia.
connectionStateUpdatedTime	string	Data i godzina ostatniej aktualizacji stanu połączenia.
deviceId	string	Unikatowy identyfikator urządzenia.
deviceScope	string	Zakres urządzenia. Automatycznie generowane i niezmienne dla urządzeń brzegowych oraz modyfikowalne na urządzeniach liścia w celu utworzenia relacji podrzędnej/nadrzędnej.
etag	string	Ciąg reprezentujący słaby element ETag dla tożsamości urządzenia zgodnie z RFC7232.
generationId	string	Wygenerowany IoT Hub ciąg uwzględniający wielkość liter do 128 znaków. Ta wartość służy do odróżnienia urządzeń za pomocą tego samego identyfikatora deviceId, gdy zostały usunięte i utworzone ponownie.
lastActivityTime	string	Data i godzina ostatniego połączenia, odebrania lub wysłania wiadomości przez urządzenie.
parentScopes	string[]	Zakresy urządzeń brzegowych wyższego poziomu, jeśli ma to zastosowanie. Dostępne tylko dla urządzeń brzegowych.
status	enum: enabled disabled	Stan urządzenia. Jeśli stan jest wyłączony, urządzenie nie może nawiązać połączenia z usługą.
statusReason	string	128-znakowy ciąg, który przechowuje przyczynę stanu tożsamości urządzenia. Dozwolone są wszystkie znaki UTF-8.
statusUpdatedTime	string	Data i godzina ostatniej aktualizacji pola stanu.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	Device	OK.

Definicje

Nazwa	Opis
AuthenticationMechanism
Device
DeviceCapabilities	Stan możliwości włączonych na urządzeniu.
SymmetricKey
X509Thumbprint

AuthenticationMechanism

Nazwa	Typ	Opis
symmetricKey	SymmetricKey	Podstawowe i pomocnicze klucze używane do uwierzytelniania opartego na sygnaturze dostępu współdzielonego.
type	enum: certificateAuthority none sas selfSigned	Typ uwierzytelniania używanego do nawiązywania połączenia z usługą.
x509Thumbprint	X509Thumbprint	Podstawowe i pomocnicze odciski palca x509 używane do uwierzytelniania opartego na architekturze x509.

Device

Nazwa	Typ	Opis
authentication	AuthenticationMechanism	Mechanizm uwierzytelniania używany przez urządzenie.
capabilities	DeviceCapabilities	Zestaw możliwości urządzenia. Jeśli na przykład to urządzenie jest urządzeniem brzegowym, czy nie.
cloudToDeviceMessageCount	integer	Liczba komunikatów przesyłanych z chmury do urządzenia, które mają być obecnie wysyłane do urządzenia.
connectionState	enum: Connected Disconnected	Stan urządzenia.
connectionStateUpdatedTime	string	Data i godzina ostatniej aktualizacji stanu połączenia.
deviceId	string	Unikatowy identyfikator urządzenia.
deviceScope	string	Zakres urządzenia. Automatycznie generowane i niezmienne dla urządzeń brzegowych oraz modyfikowalne na urządzeniach liścia w celu utworzenia relacji podrzędnej/nadrzędnej.
etag	string	Ciąg reprezentujący słaby element ETag dla tożsamości urządzenia zgodnie z RFC7232.
generationId	string	Wygenerowany IoT Hub ciąg uwzględniający wielkość liter do 128 znaków. Ta wartość służy do odróżnienia urządzeń za pomocą tego samego identyfikatora deviceId, gdy zostały usunięte i utworzone ponownie.
lastActivityTime	string	Data i godzina ostatniego połączenia, odebrania lub wysłania wiadomości przez urządzenie.
parentScopes	string[]	Zakresy urządzeń brzegowych wyższego poziomu, jeśli ma to zastosowanie. Dostępne tylko dla urządzeń brzegowych.
status	enum: disabled enabled	Stan urządzenia. Jeśli stan jest wyłączony, urządzenie nie może nawiązać połączenia z usługą.
statusReason	string	128-znakowy ciąg, który przechowuje przyczynę stanu tożsamości urządzenia. Dozwolone są wszystkie znaki UTF-8.
statusUpdatedTime	string	Data i godzina ostatniej aktualizacji pola stanu.

DeviceCapabilities

Stan możliwości włączonych na urządzeniu.

Nazwa	Typ	Opis
iotEdge	boolean	Właściwość określająca, czy urządzenie jest urządzeniem brzegowym, czy nie.

SymmetricKey

Nazwa	Typ	Opis
primaryKey	string	Zakodowany w formacie base64 klucz podstawowy urządzenia.
secondaryKey	string	Zakodowany w formacie base64 klucz pomocniczy urządzenia.

X509Thumbprint

Nazwa	Typ	Opis
primaryThumbprint	string	Podstawowy odcisk palca certyfikatu klienta X509.
secondaryThumbprint	string	Pomocniczy odcisk palca certyfikatu klienta X509.