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

Nazwisko W Wymagane Typ Opis
deviceId
 path True

string

Unikatowy identyfikator urządzenia.
api-version
 query True

string

Wersja interfejsu API.

Treść żądania

Nazwisko Typ Opis
connectTimeoutInSeconds

integer (int32)

methodName

string

Nazwa metody do wykonania.
payload

object

Ładunek metody bezpośredniej w formacie JSON o rozmiarze do 128 kb.
responseTimeoutInSeconds

integer (int32)

Odpowiedzi

Nazwisko Typ Opis
200 OK

CloudToDeviceMethodResult

OK.

Definicje

Nazwisko Opis
CloudToDeviceMethod

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

Reprezentuje wyniki wywołania metody urządzenia.

CloudToDeviceMethod

Objekt

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

Nazwisko Typ Opis
connectTimeoutInSeconds

integer (int32)

methodName

string

Nazwa metody do wykonania.
payload

object

Ładunek metody bezpośredniej w formacie JSON o rozmiarze do 128 kb.
responseTimeoutInSeconds

integer (int32)

CloudToDeviceMethodResult

Objekt

Reprezentuje wyniki wywołania metody urządzenia.

Nazwisko Typ Opis
payload

object

Ładunek wyniku wywołania metody.
status

integer (int32)

Stan wyniku wywołania metody.