Digital Twin - Invoke Component Command

  • Referência
Service:
IoT Hub
API Version:
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
With optional parameters: 
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 de URI

Nome Em Obrigató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 gêmeo digital aguardará a resposta.
responseTimeoutInSeconds
 query

integer

int32

Intervalo máximo de tempo, em segundos, que o comando gêmeo digital aguardará a resposta.

Corpo da solicitação

Nome Tipo Description
payload

object

Respostas

Nome Tipo Description
200 OK

object

Retorna o conteúdo da resposta de comando do gêmeo digital

Headers

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