Devices - Run Command

Servizio:

IoT Central

Versione API:

2022-07-31

Eseguire un comando del dispositivo
Eseguire un comando in un dispositivo.

POST https://{subdomain}.{baseDomain}/api/devices/{deviceId}/commands/{commandName}?api-version=2022-07-31

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
baseDomain	path	True	string	Dominio di base per tutte le richieste del servizio Azure IoT Central.
commandName	path	True	string	Nome del comando del dispositivo.
deviceId	path	True	string	ID univoco del dispositivo.
subdomain	path	True	string	Sottodominio dell'applicazione.
api-version	query	True	string	Versione dell'API chiamata.

Corpo della richiesta

Nome	Tipo	Descrizione
connectionTimeout	integer (int32) minimum: 0 maximum: 30	Timeout della connessione in secondi per attendere che un dispositivo disconnesso venga online. Il valore predefinito è 0 secondi.
request		Il payload per il comando del dispositivo supporta qualsiasi tipo o oggetto primitivo.
responseTimeout	integer (int32) minimum: 5 maximum: 30	Timeout di risposta in secondi per attendere il completamento di un comando in un dispositivo. Il valore predefinito è 30 secondi.

Risposte

Nome	Tipo	Descrizione
201 Created	DeviceCommand	Successo
Other Status Codes	Error	Risposta di errore ricevuta dal servizio IoT Central. Intestazioni x-ms-error-code: string

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

Send command

Esempio di richiesta

HTTP

POST https://appsubdomain.azureiotcentral.com/api/devices/mx1/commands/CoolDown?api-version=2022-07-31

{
  "request": {
    "tempVal": 30
  }
}

Risposta di esempio

Codice di stato:

201

{}

Definizioni

Nome	Descrizione
DeviceCommand	Definizione del comando del dispositivo.
Error	Definizione dell'errore di risposta.
ErrorDetails	Informazioni dettagliate sull'errore.

DeviceCommand

Object

Definizione del comando del dispositivo.

Nome	Tipo	Descrizione
connectionTimeout	integer (int32) minimum: 0 maximum: 30	Timeout della connessione in secondi per attendere che un dispositivo disconnesso venga online. Il valore predefinito è 0 secondi.
id	string	ID richiesta dell'esecuzione del comando del dispositivo.
request		Il payload per il comando del dispositivo supporta qualsiasi tipo o oggetto primitivo.
response		Il payload della risposta del comando del dispositivo, supporta qualsiasi tipo o oggetto primitivo.
responseCode	integer (int32)	Codice di stato della risposta del comando del dispositivo.
responseTimeout	integer (int32) minimum: 5 maximum: 30	Timeout di risposta in secondi per attendere il completamento di un comando in un dispositivo. Il valore predefinito è 30 secondi.

Error

Object

Definizione dell'errore di risposta.

Nome	Tipo	Descrizione
error	ErrorDetails	Dettagli dell'errore per la richiesta corrente.

ErrorDetails

Object

Informazioni dettagliate sull'errore.

Nome	Tipo	Descrizione
code	string	Codice di errore.
message	string	Dettagli del messaggio di errore.
requestId	string	ID correlazione per la richiesta corrente.
time	string (date-time-rfc1123)	Ora in cui la richiesta di errore non è riuscita.