Devices - Invoke Method

Service:

IoT Hub

API-versie:

2021-04-12

Roept een directe methode aan op een apparaat. Zie https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-direct-methods voor meer informatie.

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

URI-parameters

Name	In	Vereist	Type	Description
deviceId	path	True	string	De unieke id van het apparaat.
api-version	query	True	string	Versie van de API.

Aanvraagbody

Name	Type	Description
connectTimeoutInSeconds	integer (int32)
methodName	string	De naam van de methode die moet worden uitgevoerd.
payload	object	De nettolading van de directe methode met JSON-indeling, tot 128 kB.
responseTimeoutInSeconds	integer (int32)

Antwoorden

Name	Type	Description
200 OK	CloudToDeviceMethodResult	OK.

Definities

Name	Description
CloudToDeviceMethod	De parameters voor het uitvoeren van een directe methode op het apparaat.
CloudToDeviceMethodResult	Vertegenwoordigt de resultaten van de aanroep van de apparaatmethode.

CloudToDeviceMethod

Object

De parameters voor het uitvoeren van een directe methode op het apparaat.

Name	Type	Description
connectTimeoutInSeconds	integer (int32)
methodName	string	De naam van de methode die moet worden uitgevoerd.
payload	object	De nettolading van de directe methode met JSON-indeling, tot 128 kB.
responseTimeoutInSeconds	integer (int32)

CloudToDeviceMethodResult

Object

Vertegenwoordigt de resultaten van de aanroep van de apparaatmethode.

Name	Type	Description
payload	object	Nettolading van methode-aanroepresultaat.
status	integer (int32)	Resultaatstatus van methode-aanroep.