Devices - Run Component Command

Ejecución de un comando de componente
Ejecute un comando en un componente.

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

Parámetros de identificador URI

Name In Required Type Description
baseDomain
path True
  • string

Dominio base para todas las solicitudes de servicio de Azure IoT Central.

commandName
path True
  • string

Nombre de este comando de dispositivo.

componentName
path True
  • string

Nombre del componente del dispositivo.

deviceId
path True
  • string

Identificador único del dispositivo.

subdomain
path True
  • string

Subdominio de aplicación.

api-version
query True
  • string

Versión de la API a la que se llama.

Cuerpo de la solicitud

Name Type Description
connectionTimeout
  • integer

Tiempo de espera de conexión en segundos para esperar a que un dispositivo desconectado se conecte. El valor predeterminado es 0 segundos.

request

La carga del comando de dispositivo, admite cualquier tipo o objeto primitivos.

responseTimeout
  • integer

Tiempo de espera de respuesta en segundos para esperar la finalización de un comando en un dispositivo. El valor predeterminado es 30 segundos.

Respuestas

Name Type Description
201 Created

Correcto

Other Status Codes

Respuesta de error recibida del servicio IoT Central.

Headers

  • x-ms-error-code: string

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory

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

Scopes

Name Description
user_impersonation suplantar la cuenta de usuario

Ejemplos

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

{}

Definiciones

DeviceCommand

Definición del comando de dispositivo.

Error

Definición de error de respuesta.

ErrorDetails

Información detallada del error.

DeviceCommand

Definición del comando de dispositivo.

Name Type Description
connectionTimeout
  • integer

Tiempo de espera de conexión en segundos para esperar a que un dispositivo desconectado se conecte. El valor predeterminado es 0 segundos.

id
  • string

Identificador de solicitud de la ejecución del comando del dispositivo.

request

La carga del comando de dispositivo, admite cualquier tipo o objeto primitivos.

response

La carga de la respuesta del comando del dispositivo, admite cualquier tipo primitivo o objeto.

responseCode
  • integer

Código de estado de la respuesta del comando del dispositivo.

responseTimeout
  • integer

Tiempo de espera de respuesta en segundos para esperar la finalización de un comando en un dispositivo. El valor predeterminado es 30 segundos.

Error

Definición de error de respuesta.

Name Type Description
error

Detalles del error de la solicitud actual.

ErrorDetails

Información detallada del error.

Name Type Description
code
  • string

Código de error.

message
  • string

Detalles del mensaje de error.

requestId
  • string

Id. de correlación para la solicitud actual.

time
  • string

La hora en que se produjo un error en la solicitud de error.