Modules - Invoke Method

Servicio:

IoT Hub

Versión de la API:

2021-04-12

Invoca un método directo en un módulo de un dispositivo. Consulte https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-direct-methods para obtener más información.

POST https://fully-qualified-iothubname.azure-devices.net/twins/{deviceId}/modules/{moduleId}/methods?api-version=2021-04-12

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
deviceId	path	True	string	Identificador único del dispositivo.
moduleId	path	True	string	Identificador único del módulo.
api-version	query	True	string	Versión de la API.

Cuerpo de la solicitud

Nombre	Tipo	Description
connectTimeoutInSeconds	integer
methodName	string	Nombre del método que se va a ejecutar.
payload	object	Carga del método directo con formato JSON, de hasta 128 kb de tamaño.
responseTimeoutInSeconds	integer

Respuestas

Nombre	Tipo	Description
200 OK	CloudToDeviceMethodResult	Aceptar.

Definiciones

Nombre	Description
CloudToDeviceMethod	Parámetros para ejecutar un método directo en el dispositivo.
CloudToDeviceMethodResult	Representa los resultados de invocación del método de dispositivo.

CloudToDeviceMethod

Parámetros para ejecutar un método directo en el dispositivo.

Nombre	Tipo	Description
connectTimeoutInSeconds	integer
methodName	string	Nombre del método que se va a ejecutar.
payload	object	Carga del método directo con formato JSON, de hasta 128 kb de tamaño.
responseTimeoutInSeconds	integer

CloudToDeviceMethodResult

Representa los resultados de invocación del método de dispositivo.

Nombre	Tipo	Description
payload	object	Carga de resultados de invocación de métodos.
status	integer	Estado del resultado de la invocación del método.