Partilhar via

Digital Twin - Invoke Component Command

Serviço:
IoT Hub
Versão da API:
2021-04-12

Invoque um comando de gêmeo digital.

POST https://fully-qualified-iothubname.azure-devices.net/digitaltwins/{id}/components/{componentPath}/commands/{commandName}?api-version=2021-04-12
Com parâmetros opcionais: 
POST https://fully-qualified-iothubname.azure-devices.net/digitaltwins/{id}/components/{componentPath}/commands/{commandName}?api-version=2021-04-12&connectTimeoutInSeconds={connectTimeoutInSeconds}&responseTimeoutInSeconds={responseTimeoutInSeconds}

Parâmetros do URI

Name Em Necessário Tipo Description
commandName
 path True

string

componentPath
 path True

string

id
 path True

string

api-version
 query True

string

Versão da Api.
connectTimeoutInSeconds
 query

integer (int32)

Intervalo máximo de tempo, em segundos, que o comando digital twin aguardará pela resposta.
responseTimeoutInSeconds
 query

integer (int32)

Intervalo máximo de tempo, em segundos, que o comando digital twin aguardará pela resposta.

Corpo do Pedido

Name Tipo Description
payload

object

Respostas

Name Tipo Description
200 OK

object

Devolve a carga útil de resposta do comando digital twin

Cabeçalhos

  • x-ms-command-statuscode: integer
  • x-ms-request-id: string