Devices - Run Component Command

Köra ett komponentkommando
Kör ett kommando på en komponent.

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

URI-parametrar

Name In Required Type Description
baseDomain
path True
  • string

Basdomänen för alla Azure IoT Central-tjänstbegäranden.

commandName
path True
  • string

Namnet på det här enhetskommandot.

componentName
path True
  • string

Namnet på enhetskomponenten.

deviceId
path True
  • string

Unikt ID för enheten.

subdomain
path True
  • string

Programmets underdomän.

api-version
query True
  • string

Den version av API:et som anropas.

Begärandetext

Name Type Description
connectionTimeout
  • integer

Tidsgräns för anslutning i sekunder för att vänta tills en frånkopplad enhet är online. Standardvärdet är 0 sekunder.

request

Nyttolasten för enhetskommandot stöder alla primitiva typer eller objekt.

responseTimeout
  • integer

Svarstimeout i sekunder för att vänta på att ett kommando har slutförts på en enhet. Standardvärdet är 30 sekunder.

Svar

Name Type Description
201 Created

Klart

Other Status Codes

Ett felsvar som tagits emot från IoT Central-tjänsten.

Headers

  • x-ms-error-code: string

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name Description
user_impersonation personifiera ditt användarkonto

Exempel

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

{}

Definitioner

DeviceCommand

Enhetskommandodefinitionen.

Error

Definitionen av svarsfel.

ErrorDetails

Detaljerad information om felet.

DeviceCommand

Enhetskommandodefinitionen.

Name Type Description
connectionTimeout
  • integer

Tidsgräns för anslutning i sekunder för att vänta tills en frånkopplad enhet är online. Standardvärdet är 0 sekunder.

id
  • string

Begärande-ID för körningen av enhetskommandot.

request

Nyttolasten för enhetskommandot stöder alla primitiva typer eller objekt.

response

Nyttolasten för enhetens kommandosvar stöder alla primitiva typer eller objekt.

responseCode
  • integer

Statuskoden för enhetskommandosvaret.

responseTimeout
  • integer

Svarstimeout i sekunder för att vänta på att ett kommando har slutförts på en enhet. Standardvärdet är 30 sekunder.

Error

Definitionen av svarsfel.

Name Type Description
error

Felinformation för aktuell begäran.

ErrorDetails

Detaljerad information om felet.

Name Type Description
code
  • string

Felkod.

message
  • string

Information om felmeddelanden.

requestId
  • string

Korrelations-ID för aktuell begäran.

time
  • string

Den tid då felbegäran misslyckades.