Modules - Create Or Update Identity

  • Ссылка
Служба:
IoT Hub
Версия API:
2021-04-12

Создает или обновляет удостоверение модуля для устройства в Центр Интернета вещей. Пользователь не может обновить moduleId и generationId.

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

Параметры URI

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

string

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

string

Уникальный идентификатор модуля.
api-version
 query True

string

Версия API.

Заголовок запроса

Имя Обязательно Тип Описание
If-Match

string

Строка, представляющая слабый ETag для модуля в RFC7232. Это значение не должно быть задано при создании модуля, но может быть задано при обновлении модуля.

Текст запроса

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

AuthenticationMechanism

Механизм проверки подлинности, используемый модулем при подключении к службе и пограничному концентратору.
cloudToDeviceMessageCount

integer

Количество сообщений, передаваемых из облака в модуль, которые в данный момент находятся в очереди для отправки в модуль.
connectionState enum:
  • Disconnected
  • Connected

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

string

Дата и время последнего обновления состояния подключения.
deviceId

string

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

string

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

string

Строка Центр Интернета вещей с учетом регистра длиной до 128 символов. Это значение используется для различения модулей с одинаковым идентификатором moduleId при их удалении и повторном создании.
lastActivityTime

string

Дата и время последнего подключения, получения или отправки сообщения устройством.
managedBy

string

Определяет, кто управляет этим модулем. Например, это значение равно IotEdge, если этим модулем владеет среда выполнения пограничной среды.
moduleId

string

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

Ответы

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

Module

Все в порядке.
201 Created

Module

Создан.

Определения

Имя Описание
AuthenticationMechanism
Module

Удостоверение модуля на устройстве.
SymmetricKey
X509Thumbprint

AuthenticationMechanism

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

SymmetricKey

Первичный и вторичный ключи, используемые для проверки подлинности на основе SAS.
type enum:
  • certificateAuthority
  • none
  • sas
  • selfSigned

Тип проверки подлинности, используемый для подключения к службе.
x509Thumbprint

X509Thumbprint

Первичные и вторичные отпечатки x509, используемые для проверки подлинности на основе x509.

Module

Удостоверение модуля на устройстве.

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

AuthenticationMechanism

Механизм проверки подлинности, используемый модулем при подключении к службе и пограничному концентратору.
cloudToDeviceMessageCount

integer

Количество сообщений, передаваемых из облака в модуль, которые в данный момент находятся в очереди для отправки в модуль.
connectionState enum:
  • Connected
  • Disconnected

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

string

Дата и время последнего обновления состояния подключения.
deviceId

string

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

string

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

string

Строка Центр Интернета вещей с учетом регистра длиной до 128 символов. Это значение используется для различения модулей с одинаковым идентификатором moduleId при их удалении и повторном создании.
lastActivityTime

string

Дата и время последнего подключения, получения или отправки сообщения устройством.
managedBy

string

Определяет, кто управляет этим модулем. Например, это значение равно IotEdge, если этим модулем владеет среда выполнения пограничной среды.
moduleId

string

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

SymmetricKey

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

string

Первичный ключ устройства в кодировке Base64.
secondaryKey

string

Вторичный ключ устройства в кодировке Base64.

X509Thumbprint

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

string

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

string

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