Devices - Get Identity

Service:
IoT Hub
API Version:
2020-05-31-preview

Pobiera urządzenie z rejestru tożsamości IoT Hub.

GET https://fully-qualified-iothubname.azure-devices.net/devices/{id}?api-version=2020-05-31-preview

Parametry identyfikatora URI

Name In Required Type Description
id
 path True
  • string

Unikatowy identyfikator urządzenia.
api-version
 query True
  • string

Wersja interfejsu API.

Odpowiedzi

Name Type Description
200 OK

OK.

Definicje

AuthenticationMechanism
Device
DeviceCapabilities

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

AuthenticationMechanism

Name Type Description
symmetricKey

Klucze podstawowe i pomocnicze używane do uwierzytelniania opartego na SAS.
type enum:
  • certificateAuthority
  • none
  • sas
  • selfSigned

Typ uwierzytelniania używany do nawiązywania połączenia z usługą.
x509Thumbprint

Podstawowy i pomocniczy odcisk palca x509 używany na potrzeby uwierzytelniania na podstawie certyfikatu x509.

Device

Name Type Description
authentication

Mechanizm uwierzytelniania używany przez urządzenie.
capabilities

Zestaw możliwości urządzenia. Na przykład jeśli to urządzenie jest urządzeniem brzegowym lub nie.
cloudToDeviceMessageCount
  • integer

Liczba komunikatów z chmury do urządzenia znajdujących się obecnie w kolejce do wysłania 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. Generowane automatycznie i niezmienne dla urządzeń brzegowych i modyfikowalne na urządzeniach liściowych, aby utworzyć relację podrzędną/nadrzędną.
etag
  • string

Ciąg reprezentujący słaby element ETag dla tożsamości urządzenia, zgodnie z RFC7232.
generationId
  • string

Wygenerowane przez IoT Hub ciągi z rozróżnianiem wielkości liter o długości do 128 znaków. Ta wartość jest używana do rozróżniania urządzeń z tym samym identyfikatorem deviceId, gdy zostały usunięte i ponownie utworzone.
lastActivityTime
  • string

Data i godzina ostatniego połączenia urządzenia, odebrania lub wysłania komunikatu.
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

Ciąg o długości 128 znaków, 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.

Name Type Description
iotEdge
  • boolean

Właściwość, która określa, czy urządzenie jest urządzeniem brzegowym, czy nie.

SymmetricKey

Name Type Description
primaryKey
  • string

Klucz podstawowy kodowany algorytmem Base64 urządzenia.
secondaryKey
  • string

Klucz pomocniczy kodowany algorytmem Base64 urządzenia.

X509Thumbprint

Name Type Description
primaryThumbprint
  • string

Podstawowy odcisk palca certyfikatu klienta x509.
secondaryThumbprint
  • string

Pomocniczy odcisk palca certyfikatu klienta x509.