Devices - Run Component Command

Executar um comando de componente
Executar um comando num componente.

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

Parâmetros do URI

Name In Required Type Description
baseDomain
path True
  • string

O domínio base para todos os pedidos de serviço Azure IoT Central.

commandName
path True
  • string

Nome deste comando do dispositivo.

componentName
path True
  • string

Nome do componente do dispositivo.

deviceId
path True
  • string

Identificação única do dispositivo.

subdomain
path True
  • string

O subdomínio da aplicação.

api-version
query True
  • string

A versão da API a ser chamada.

Corpo do Pedido

Name Type Description
connectionTimeout
  • integer

Intervalo de ligação em segundos para aguardar que um dispositivo desligado esteja ligado. Predefinições a 0 segundos.

request

A carga útil para o comando do dispositivo, suporta quaisquer tipos primitivos ou objetos.

responseTimeout
  • integer

Tempo de resposta em segundos para aguardar a conclusão do comando de um dispositivo. Predefinição a 30 segundos.

Respostas

Name Type Description
201 Created

Com êxito

Other Status Codes

Uma resposta de erro recebida do Serviço Central IoT.

Headers

  • x-ms-error-code: string

Segurança

azure_auth

Azure Ative Directory OAuth2 Flow

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

Scopes

Name Description
user_impersonation personificar a sua conta de utilizador

Exemplos

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

{}

Definições

DeviceCommand

A definição de comando do dispositivo.

Error

A definição de erro de resposta.

ErrorDetails

A informação detalhada do erro.

DeviceCommand

A definição de comando do dispositivo.

Name Type Description
connectionTimeout
  • integer

Intervalo de ligação em segundos para aguardar que um dispositivo desligado esteja ligado. Predefinições a 0 segundos.

id
  • string

A identificação do pedido da execução do comando do dispositivo.

request

A carga útil para o comando do dispositivo, suporta quaisquer tipos primitivos ou objetos.

response

A carga útil da resposta do comando do dispositivo, suporta quaisquer tipos ou objetos primitivos.

responseCode
  • integer

O código de estado da resposta do comando do dispositivo.

responseTimeout
  • integer

Tempo de resposta em segundos para aguardar a conclusão do comando de um dispositivo. Predefinição a 30 segundos.

Error

A definição de erro de resposta.

Name Type Description
error

Detalhes de erro para pedido atual.

ErrorDetails

A informação detalhada do erro.

Name Type Description
code
  • string

Código de erro.

message
  • string

Detalhes da mensagem de erro.

requestId
  • string

Id de correlação para pedido atual.

time
  • string

O tempo que o pedido de erro falhou.