Modules - Invoke Method

Service:

IoT Hub

API Version:

2020-05-31-preview

Вызывает прямой метод в модуле устройства. Подробнее см. в разделе https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-direct-methods.

POST https://fully-qualified-iothubname.azure-devices.net/twins/{deviceId}/modules/{moduleId}/methods?api-version=2020-05-31-preview

Параметры URI

Имя	В	Обязательно	Тип	Описание
deviceId	path	True	string	Уникальный идентификатор устройства.
moduleId	path	True	string	Уникальный идентификатор модуля.
api-version	query	True	string	Версия API.

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

Имя	Тип	Описание
connectTimeoutInSeconds	integer
methodName	string	Имя метода, который необходимо выполнить.
payload	object	Полезные данные прямого метода в формате JSON размером до 128 КБ.
responseTimeoutInSeconds	integer

Ответы

Имя	Тип	Описание
200 OK	CloudToDeviceMethodResult	Все в порядке.

Определения

Имя	Описание
CloudToDeviceMethod	Параметры для выполнения прямого метода на устройстве.
CloudToDeviceMethodResult	Представляет результаты вызова метода устройства.

CloudToDeviceMethod

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

Имя	Тип	Описание
connectTimeoutInSeconds	integer
methodName	string	Имя метода, который необходимо выполнить.
payload	object	Полезные данные прямого метода в формате JSON размером до 128 КБ.
responseTimeoutInSeconds	integer

CloudToDeviceMethodResult

Представляет результаты вызова метода устройства.

Имя	Тип	Описание
payload	object	Полезные данные результата вызова метода.
status	integer	Состояние результата вызова метода.