Devices - Run Component Command

Выполнение команды компонента
Выполните команду в компоненте.

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

Параметры URI

Name In Required Type Description
baseDomain
path True
  • string

Базовый домен для всех запросов на обслуживание Azure IoT Central.

commandName
path True
  • string

Имя этой команды устройства.

componentName
path True
  • string

Имя компонента устройства.

deviceId
path True
  • string

Уникальный идентификатор устройства.

subdomain
path True
  • string

Поддомен приложения.

api-version
query True
  • string

Версия вызываемого API.

Текст запроса

Name Type Description
connectionTimeout
  • integer

Время ожидания подключения в секундах, пока отключенное устройство будет подключено к сети. Значение по умолчанию — 0 секунд.

request

Полезные данные для команды устройства поддерживают любые примитивные типы или объекты.

responseTimeout
  • integer

Время ожидания ответа в секундах, чтобы дождаться завершения команды на устройстве. Значение по умолчанию — 30 секунд.

Ответы

Name Type Description
201 Created

Успешное завершение

Other Status Codes

Ответ об ошибке, полученный от службы IoT Central.

Headers

  • x-ms-error-code: string

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory

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

Scopes

Name Description
user_impersonation олицетворения учетной записи пользователя

Примеры

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

{}

Определения

DeviceCommand

Определение команды устройства.

Error

Определение ошибки ответа.

ErrorDetails

Подробные сведения об ошибке.

DeviceCommand

Определение команды устройства.

Name Type Description
connectionTimeout
  • integer

Время ожидания подключения в секундах, пока отключенное устройство будет подключено к сети. Значение по умолчанию — 0 секунд.

id
  • string

Идентификатор запроса выполнения команды устройства.

request

Полезные данные для команды устройства поддерживают любые примитивные типы или объекты.

response

Полезные данные ответа команды устройства поддерживают любые примитивные типы или объекты.

responseCode
  • integer

Код состояния ответа команды устройства.

responseTimeout
  • integer

Время ожидания ответа в секундах, чтобы дождаться завершения команды на устройстве. Значение по умолчанию — 30 секунд.

Error

Определение ошибки ответа.

Name Type Description
error

Сведения об ошибке для текущего запроса.

ErrorDetails

Подробные сведения об ошибке.

Name Type Description
code
  • string

Код ошибки.

message
  • string

Сведения об сообщении об ошибке.

requestId
  • string

Идентификатор корреляции для текущего запроса.

time
  • string

Время сбоя запроса на ошибку.