Modules - Create Or Update Identity

  • Odwołanie
Service:
IoT Hub
API Version:
2021-04-12

Tworzy lub aktualizuje tożsamość modułu dla urządzenia w IoT Hub. Nie można zaktualizować identyfikatora moduleId i identyfikatora generationId przez użytkownika.

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
id
 path True

string

Unikatowy identyfikator urządzenia.
mid
 path True

string

Unikatowy identyfikator modułu.
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 modułu zgodnie z RFC7232. Nie należy ustawiać tego ustawienia podczas tworzenia modułu, ale można go ustawić podczas aktualizowania modułu.

Treść żądania

Nazwa Typ Opis
authentication

AuthenticationMechanism

Mechanizm uwierzytelniania używany przez moduł podczas nawiązywania połączenia z usługą i koncentratorem brzegowym.
cloudToDeviceMessageCount

integer

Liczba komunikatów z chmury do modułu, które mają być obecnie wysyłane do modułu.
connectionState enum:
  • Disconnected
  • Connected

Stan połączenia urządzenia.
connectionStateUpdatedTime

string

Data i godzina ostatniej aktualizacji stanu połączenia.
deviceId

string

Unikatowy identyfikator urządzenia.
etag

string

Ciąg reprezentujący słabą wartość ETag dla tożsamości modułu zgodnie z RFC7232.
generationId

string

Wygenerowany IoT Hub ciąg z uwzględnieniem wielkości liter do 128 znaków. Ta wartość służy do rozróżniania modułów o tym samym identyfikatorze moduleId, gdy zostały usunięte i ponownie utworzone.
lastActivityTime

string

Data i godzina ostatniego połączenia, odebrania lub wysłania wiadomości przez urządzenie.
managedBy

string

Określa, kto zarządza tym modułem. Na przykład ta wartość to "IotEdge", jeśli środowisko uruchomieniowe krawędzi jest właścicielem tego modułu.
moduleId

string

Unikatowy identyfikator modułu.

Odpowiedzi

Nazwa Typ Opis
200 OK

Module

OK.
201 Created

Module

Utworzone.

Definicje

Nazwa Opis
AuthenticationMechanism
Module

Tożsamość modułu 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 palców x509 używane do uwierzytelniania opartego na architekturze x509.

Module

Tożsamość modułu na urządzeniu.

Nazwa Typ Opis
authentication

AuthenticationMechanism

Mechanizm uwierzytelniania używany przez moduł podczas nawiązywania połączenia z usługą i koncentratorem brzegowym.
cloudToDeviceMessageCount

integer

Liczba komunikatów z chmury do modułu, które mają być obecnie wysyłane do modułu.
connectionState enum:
  • Connected
  • Disconnected

Stan połączenia urządzenia.
connectionStateUpdatedTime

string

Data i godzina ostatniej aktualizacji stanu połączenia.
deviceId

string

Unikatowy identyfikator urządzenia.
etag

string

Ciąg reprezentujący słabą wartość ETag dla tożsamości modułu zgodnie z RFC7232.
generationId

string

Wygenerowany IoT Hub ciąg z uwzględnieniem wielkości liter do 128 znaków. Ta wartość służy do rozróżniania modułów o tym samym identyfikatorze moduleId, gdy zostały usunięte i ponownie utworzone.
lastActivityTime

string

Data i godzina ostatniego połączenia, odebrania lub wysłania wiadomości przez urządzenie.
managedBy

string

Określa, kto zarządza tym modułem. Na przykład ta wartość to "IotEdge", jeśli środowisko uruchomieniowe krawędzi jest właścicielem tego modułu.
moduleId

string

Unikatowy identyfikator modułu.

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.