Digital Twin - Invoke Component Command

  • Riferimento
Service:
IoT Hub
API Version:
2021-04-12

Richiamare un comando gemello digitale.

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}

Parametri dell'URI

Nome In Necessario Tipo Descrizione
commandName
 path True

string

componentPath
 path True

string

id
 path True

string

api-version
 query True

string

Versione dell'API.
connectTimeoutInSeconds
 query

integer

int32

Intervallo massimo di tempo, in secondi, che il comando gemello digitale attenderà la risposta.
responseTimeoutInSeconds
 query

integer

int32

Intervallo massimo di tempo, in secondi, che il comando gemello digitale attenderà la risposta.

Corpo della richiesta

Nome Tipo Descrizione
payload

object

Risposte

Nome Tipo Descrizione
200 OK

object

Restituisce il payload della risposta del comando di Gemelli digitali

Headers

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