Modules - Get Twin

Возвращает двойник модуля. Подробнее см. в разделе https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins.

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

Параметры URI

Имя В Обязательно Тип Описание
id
path True

string

Уникальный идентификатор устройства.

mid
path True

string

Уникальный идентификатор модуля.

api-version
query True

string

Версия API.

Ответы

Имя Тип Описание
200 OK

Twin

Сведения о состоянии модуля.

Определения

Имя Описание
DeviceCapabilities

Состояние возможностей, включенных на устройстве.

Twin

Сведения о состоянии устройства или модуля. Он неявно создается и удаляется при создании или удалении соответствующего удостоверения устройства или модуля в Центр Интернета вещей.

TwinProperties

Требуемые и сообщаемые свойства двойника. Максимальная глубина объекта — 10.

X509Thumbprint

DeviceCapabilities

Состояние возможностей, включенных на устройстве.

Имя Тип Описание
iotEdge

boolean

Свойство, определяющее, является ли устройство пограничным устройством.

Twin

Сведения о состоянии устройства или модуля. Он неявно создается и удаляется при создании или удалении соответствующего удостоверения устройства или модуля в Центр Интернета вещей.

Имя Тип Описание
authenticationType enum:
  • certificateAuthority
  • none
  • sas
  • selfSigned

Тип проверки подлинности, используемый устройством.

capabilities

DeviceCapabilities

Состояние возможностей, включенных на устройстве.

cloudToDeviceMessageCount

integer

Количество отправленных сообщений из облака на устройство.

connectionState enum:
  • Connected
  • Disconnected

Состояние подключения устройства.

deviceEtag

string

Строка, представляющая ETag для устройства в RFC7232.

deviceId

string

Уникальный идентификатор устройства в реестре удостоверений Центр Интернета вещей. Это строка с учетом регистра (длиной до 128 символов) из 7-разрядных буквенно-цифровых символов ASCII. и следующие специальные символы {'-", ":", ".", "+", "%", "_", "#", "*", "?", "!", "(", ")", ",", "=", "@", ";", "$", "", """}.

deviceScope

string

Область действия устройства.

etag

string

Строка, представляющая ETag для двойника устройства в RFC7232.

lastActivityTime

string

Дата и время последнего подключения устройства, получения или отправки сообщения. Дата и время являются последовательными в формате ISO8601 в формате UTC, например 2015-01-28T16:24:48.789Z. Это значение не обновляется, если устройство использует протокол HTTP/1 для выполнения операций обмена сообщениями.

moduleId

string

Уникальный идентификатор модуля в реестре удостоверений Центр Интернета вещей. Это строка с учетом регистра (длиной до 128 символов) из 7-разрядных буквенно-цифровых символов ASCII. и следующие специальные символы {'-", ":", ".", "+", "%", "_", "#", "*", "?", "!", "(", ")", ",", "=", "@", ";", "$", "", """}.

properties

TwinProperties

Требуемые и сообщаемые свойства двойника.

status enum:
  • disabled
  • enabled

Состояние включенного устройства. Если этот параметр отключен, устройство не сможет подключиться к службе.

statusReason

string

Причина текущего состояния устройства, если оно есть.

statusUpdateTime

string

Дата и время последнего обновления состояния устройства.

tags

object

Коллекция пар "ключ-значение", считываемых и записываемых внутренней частью решения. Они не видны приложениям устройств. Они имеют кодировку UTF-8 с учетом регистра и имеют длину до 1 КБ. Допустимые символы исключают управляющие символы ЮНИКОДа (сегменты C0 и C1), ".", "$" и пробел. Значениями являются объекты JSON длиной до 4 КБ.

version

integer

Версия двойника устройства, включая теги и требуемые свойства

x509Thumbprint

X509Thumbprint

Отпечаток устройства X509.

TwinProperties

Требуемые и сообщаемые свойства двойника. Максимальная глубина объекта — 10.

Имя Тип Описание
desired

object

Коллекция требуемых пар "ключ-значение" свойств. Ключи в кодировке UTF-8 с учетом регистра и длиной до 1 КБ. Допустимые символы исключают управляющие символы ЮНИКОДа (сегменты C0 и C1), ".", "$" и пробел. Требуемыми значениями porperty являются объекты JSON длиной до 4 КБ.

reported

object

Коллекция сообщаемых пар "ключ-значение" свойств. Ключи в кодировке UTF-8 с учетом регистра и длиной до 1 КБ. Допустимые символы исключают управляющие символы ЮНИКОДа (сегменты C0 и C1), ".", "$" и пробел. Сообщаемые значения свойств представляют собой объекты JSON длиной до 4 КБ.

X509Thumbprint

Имя Тип Описание
primaryThumbprint

string

Основной отпечаток сертификата клиента X509.

secondaryThumbprint

string

Дополнительный отпечаток сертификата клиента X509.