Devices - Run Command

Dienst:

IoT Central

API-Version:

2022-07-31

Ausführen eines Gerätebefehls
Führen Sie einen Befehl auf einem Gerät aus.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
baseDomain	path	True	string	Die Basisdomäne für alle Azure IoT Central-Dienstanforderungen.
commandName	path	True	string	Name dieses Gerätebefehls.
deviceId	path	True	string	Eindeutige ID des Geräts.
subdomain	path	True	string	Die Anwendungsdomäne.
api-version	query	True	string	Die Version der aufgerufenen API.

Anforderungstext

Name	Typ	Beschreibung
connectionTimeout	integer (int32) minimum: 0 maximum: 30	Verbindungstimeout in Sekunden, um zu warten, bis ein nicht verbundenes Gerät online ist. Der Standardwert ist 0 Sekunden.
request		Die Nutzlast für den Gerätebefehl unterstützt alle primitiven Typen oder Objekte.
responseTimeout	integer (int32) minimum: 5 maximum: 30	Antworttimeout in Sekunden, um auf den Abschluss eines Befehls auf einem Gerät zu warten. Der Standardwert ist 30 Sekunden.

Antworten

Name	Typ	Beschreibung
201 Created	DeviceCommand	Erfolg
Other Status Codes	Error	Eine Vom IoT Central Service empfangene Fehlerantwort. Header x-ms-error-code: string

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

Send command

Beispielanforderung

HTTP

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

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

Beispiel für eine Antwort

Statuscode:

201

{}

Definitionen

Name	Beschreibung
DeviceCommand	Die Gerätebefehlsdefinition.
Error	Die Antwortfehlerdefinition.
ErrorDetails	Die Detailinformationen des Fehlers.

DeviceCommand

Objekt

Die Gerätebefehlsdefinition.

Name	Typ	Beschreibung
connectionTimeout	integer (int32) minimum: 0 maximum: 30	Verbindungstimeout in Sekunden, um zu warten, bis ein nicht verbundenes Gerät online ist. Der Standardwert ist 0 Sekunden.
id	string	Die Anforderungs-ID der Ausführung des Gerätebefehls.
request		Die Nutzlast für den Gerätebefehl unterstützt alle primitiven Typen oder Objekte.
response		Die Nutzlast der Gerätebefehlsantwort unterstützt alle primitiven Typen oder Objekte.
responseCode	integer (int32)	Der Statuscode der Gerätebefehlsantwort.
responseTimeout	integer (int32) minimum: 5 maximum: 30	Antworttimeout in Sekunden, um auf den Abschluss eines Befehls auf einem Gerät zu warten. Der Standardwert ist 30 Sekunden.

Error

Objekt

Die Antwortfehlerdefinition.

Name	Typ	Beschreibung
error	ErrorDetails	Fehlerdetails für die aktuelle Anforderung.

ErrorDetails

Objekt

Die Detailinformationen des Fehlers.

Name	Typ	Beschreibung
code	string	Fehlercode.
message	string	Fehlermeldungsdetails.
requestId	string	Korrelations-ID für aktuelle Anforderung.
time	string (date-time-rfc1123)	Der Zeitpunkt, zu dem die Fehleranforderung fehlgeschlagen ist.