Modules - Invoke Method
Hiermee wordt een directe methode op een module van een apparaat aangeroepen. 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}/modules/{moduleId}/methods?api-version=2021-04-12
URI-parameters
Name | In | Vereist | Type | Description |
---|---|---|---|---|
device
|
path | True |
string |
De unieke id van het apparaat. |
module
|
path | True |
string |
De unieke id van de module. |
api-version
|
query | True |
string |
Versie van de API. |
Aanvraagbody
Name | Type | Description |
---|---|---|
connectTimeoutInSeconds |
integer |
|
methodName |
string |
De naam van de methode die moet worden uitgevoerd. |
payload |
object |
De nettolading van de directe methode in JSON-indeling, met een grootte van maximaal 128 kB. |
responseTimeoutInSeconds |
integer |
Antwoorden
Name | Type | Description |
---|---|---|
200 OK |
OK. |
Definities
Name | Description |
---|---|
Cloud |
De parameters voor het uitvoeren van een directe methode op het apparaat. |
Cloud |
Vertegenwoordigt de aanroepresultaten van de apparaatmethode. |
CloudToDeviceMethod
De parameters voor het uitvoeren van een directe methode op het apparaat.
Name | Type | Description |
---|---|---|
connectTimeoutInSeconds |
integer |
|
methodName |
string |
De naam van de methode die moet worden uitgevoerd. |
payload |
object |
De nettolading van de directe methode in JSON-indeling, met een grootte van maximaal 128 kB. |
responseTimeoutInSeconds |
integer |
CloudToDeviceMethodResult
Vertegenwoordigt de aanroepresultaten van de apparaatmethode.
Name | Type | Description |
---|---|---|
payload |
object |
Nettolading van methode-aanroepresultaat. |
status |
integer |
Resultaatstatus van methode-aanroep. |