Devices - Run Component Command

Spuštění příkazu komponenty
Spusťte příkaz na komponentě.

POST https://{subdomain}.{baseDomain}/api/devices/{deviceId}/components/{componentName}/commands/{commandName}?api-version=2022-06-30-preview

Parametry identifikátoru URI

Name In Required Type Description
baseDomain
path True
  • string

Základní doména pro všechny požadavky služby Azure IoT Central.

commandName
path True
  • string

Název tohoto příkazu zařízení.

componentName
path True
  • string

Název komponenty zařízení.

deviceId
path True
  • string

Jedinečné ID zařízení.

subdomain
path True
  • string

Subdoména aplikace.

api-version
query True
  • string

Verze volaného rozhraní API

Text požadavku

Name Type Description
connectionTimeout
  • integer

Časový limit připojení v sekundách počkejte, až se odpojené zařízení vrátí do režimu online. Výchozí hodnota je 0 sekund.

request

Datová část příkazu zařízení podporuje všechny primitivní typy nebo objekty.

responseTimeout
  • integer

Časový limit odezvy v sekundách počkejte na dokončení příkazu na zařízení. Výchozí hodnota je 30 sekund.

Odpovědi

Name Type Description
201 Created

Success

Other Status Codes

Odpověď na chybu přijatá ze služby IoT Central

Headers

  • x-ms-error-code: string

Zabezpečení

azure_auth

Tok OAuth2 v Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation zosobnění uživatelského účtu

Příklady

Send command

Sample Request

POST https://appsubdomain.azureiotcentral.com/api/devices/mx1/components/Thermostat_1o/commands/CoolDown?api-version=2022-06-30-preview

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

Sample Response

{}

Definice

DeviceCommand

Definice příkazu zařízení.

Error

Definice chyby odpovědi.

ErrorDetails

Podrobné informace o chybě

DeviceCommand

Definice příkazu zařízení.

Name Type Description
connectionTimeout
  • integer

Časový limit připojení v sekundách počkejte, až se odpojené zařízení vrátí do režimu online. Výchozí hodnota je 0 sekund.

id
  • string

ID požadavku spuštění příkazu zařízení.

request

Datová část příkazu zařízení podporuje všechny primitivní typy nebo objekty.

response

Datová část odpovědi příkazu zařízení podporuje všechny primitivní typy nebo objekty.

responseCode
  • integer

Stavový kód odpovědi příkazu zařízení.

responseTimeout
  • integer

Časový limit odezvy v sekundách počkejte na dokončení příkazu na zařízení. Výchozí hodnota je 30 sekund.

Error

Definice chyby odpovědi.

Name Type Description
error

Podrobnosti o chybě aktuálního požadavku

ErrorDetails

Podrobné informace o chybě

Name Type Description
code
  • string

Kód chyby

message
  • string

Podrobnosti chybové zprávy

requestId
  • string

ID korelace pro aktuální požadavek.

time
  • string

Čas, kdy se žádost o chybu nezdařila.