Devices - Invoke Method

Usługa:

IoT Hub

Wersja interfejsu API:

2021-04-12

Wywołuje metodę bezpośrednią na urządzeniu. Aby uzyskać więcej informacji, zobacz 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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
deviceId	path	True	string	Unikatowy identyfikator urządzenia.
api-version	query	True	string	Wersja interfejsu API.

Treść żądania

Nazwa	Typ	Opis
connectTimeoutInSeconds	integer
methodName	string	Nazwa metody do wykonania.
payload	object	Ładunek metody bezpośredniej sformatowany w formacie JSON o rozmiarze do 128 kb.
responseTimeoutInSeconds	integer

Odpowiedzi

Nazwa	Typ	Opis
200 OK	CloudToDeviceMethodResult	OK.

Definicje

Nazwa	Opis
CloudToDeviceMethod	Parametry do wykonania metody bezpośredniej na urządzeniu.
CloudToDeviceMethodResult	Reprezentuje wyniki wywołania metody urządzenia.

CloudToDeviceMethod

Parametry do wykonania metody bezpośredniej na urządzeniu.

Nazwa	Typ	Opis
connectTimeoutInSeconds	integer
methodName	string	Nazwa metody do wykonania.
payload	object	Ładunek metody bezpośredniej sformatowany w formacie JSON o rozmiarze do 128 kb.
responseTimeoutInSeconds	integer

CloudToDeviceMethodResult

Reprezentuje wyniki wywołania metody urządzenia.

Nazwa	Typ	Opis
payload	object	Ładunek wyniku wywołania metody.
status	integer	Stan wyniku wywołania metody.