Devices - Invoke Method

Serviço:

IoT Hub

Versão da API:

2021-04-12

Invoca um método direto em um dispositivo. Consulte https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-direct-methods para obter mais informações.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
deviceId	path	True	string	O identificador exclusivo do dispositivo.
api-version	query	True	string	Versão da API.

Corpo da solicitação

Nome	Tipo	Description
connectTimeoutInSeconds	integer (int32)
methodName	string	O nome do método a ser executado.
payload	object	O conteúdo do método direto formatado por JSON, de até 128 kb de tamanho.
responseTimeoutInSeconds	integer (int32)

Respostas

Nome	Tipo	Description
200 OK	CloudToDeviceMethodResult	OKEY.

Definições

Nome	Description
CloudToDeviceMethod	Os parâmetros para executar um método direto no dispositivo.
CloudToDeviceMethodResult	Representa os resultados da invocação do método de dispositivo.

CloudToDeviceMethod

Objeto

Os parâmetros para executar um método direto no dispositivo.

Nome	Tipo	Description
connectTimeoutInSeconds	integer (int32)
methodName	string	O nome do método a ser executado.
payload	object	O conteúdo do método direto formatado por JSON, de até 128 kb de tamanho.
responseTimeoutInSeconds	integer (int32)

CloudToDeviceMethodResult

Objeto

Representa os resultados da invocação do método de dispositivo.

Nome	Tipo	Description
payload	object	Conteúdo do resultado da invocação do método.
status	integer (int32)	Status do resultado da invocação do método.