Devices - Run Component Command

Executar um comando de componente
Execute um comando em um componente.

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

Parâmetros de URI

Name In Required Type Description
baseDomain
path True
  • string

O domínio base para todas as solicitações de serviço do Azure IoT Central.

commandName
path True
  • string

Nome deste comando de dispositivo.

componentName
path True
  • string

Nome do componente do dispositivo.

deviceId
path True
  • string

ID exclusiva do dispositivo.

subdomain
path True
  • string

O subdomínio do aplicativo.

api-version
query True
  • string

A versão da API que está sendo chamada.

Corpo da solicitação

Name Type Description
connectionTimeout
  • integer

Tempo limite da conexão em segundos para aguardar um dispositivo desconectado ficar online. O padrão é 0 segundos.

request

O conteúdo do comando do dispositivo dá suporte a tipos primitivos ou objeto.

responseTimeout
  • integer

Tempo limite de resposta em segundos para aguardar a conclusão de um comando em um dispositivo. O padrão é 30 segundos.

Respostas

Name Type Description
201 Created

Êxito

Other Status Codes

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

Headers

  • x-ms-error-code: string

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

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

Scopes

Name Description
user_impersonation representar sua conta de usuário

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

As informações detalhadas do erro.

DeviceCommand

A definição de comando do dispositivo.

Name Type Description
connectionTimeout
  • integer

Tempo limite da conexão em segundos para aguardar um dispositivo desconectado ficar online. O padrão é 0 segundos.

id
  • string

A ID de solicitação da execução do comando do dispositivo.

request

O conteúdo do comando do dispositivo dá suporte a tipos primitivos ou objeto.

response

A carga da resposta de comando do dispositivo dá suporte a tipos primitivos ou objeto.

responseCode
  • integer

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

responseTimeout
  • integer

Tempo limite de resposta em segundos para aguardar a conclusão de um comando em um dispositivo. O padrão é 30 segundos.

Error

A definição de erro de resposta.

Name Type Description
error

Detalhes do erro da solicitação atual.

ErrorDetails

As informações detalhadas do erro.

Name Type Description
code
  • string

Código do erro.

message
  • string

Detalhes da mensagem de erro.

requestId
  • string

ID de correlação para a solicitação atual.

time
  • string

A hora em que a solicitação de erro falhou.