Devices - Invoke Method

Tjänst:

IoT Hub

API-version:

2021-04-12

Anropar en direktmetod 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}/methods?api-version=2021-04-12

URI-parametrar

Name	I	Obligatorisk	Typ	Description
deviceId	path	True	string	Enhetens unika identifierare.
api-version	query	True	string	Version av API:et.

Begärandetext

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

Svar

Name	Typ	Description
200 OK	CloudToDeviceMethodResult	OKEJ.

Definitioner

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

CloudToDeviceMethod

Objekt

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

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

CloudToDeviceMethodResult

Objekt

Representerar resultatet av anrop av enhetsmetod.

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