Modules - Invoke Method

Tjänst:

IoT Hub

API-version:

2021-04-12

Anropar en direktmetod på en modul på en enhet. Mer information finns i 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=2021-04-12

URI-parametrar

Name	I	Obligatorisk	Typ	Description
deviceId	path	True	string	Enhetens unika identifierare.
moduleId	path	True	string	Den unika identifieraren för modulen.
api-version	query	True	string	Version av API:et.

Begärandetext

Name	Typ	Description
connectTimeoutInSeconds	integer
methodName	string	Namnet på den metod som ska köras.
payload	object	Den JSON-formaterade direktmetodnyttolasten, upp till 128 kB i storlek.
responseTimeoutInSeconds	integer

Svar

Name	Typ	Description
200 OK	CloudToDeviceMethodResult	OK.

Definitioner

Name	Description
CloudToDeviceMethod	Parametrarna för att köra en direktmetod på enheten.
CloudToDeviceMethodResult	Representerar resultatet av anrop av enhetsmetod.

CloudToDeviceMethod

Parametrarna för att köra en direktmetod på enheten.

Name	Typ	Description
connectTimeoutInSeconds	integer
methodName	string	Namnet på den metod som ska köras.
payload	object	Den JSON-formaterade direktmetodnyttolasten, upp till 128 kB i storlek.
responseTimeoutInSeconds	integer

CloudToDeviceMethodResult

Representerar resultatet av anrop av enhetsmetod.

Name	Typ	Description
payload	object	Nyttolast för metodanropsresultat.
status	integer	Resultatstatus för metodanrop.