Devices - Run Component Command

Service:

IoT Central

API Version:

2022-07-31

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-07-31

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	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

Nome	Tipo	Description
connectionTimeout	integer	Tempo limite da conexão em segundos para aguardar um dispositivo desconectado ficar online. O padrão é 0 segundo.
request		O conteúdo do comando do dispositivo dá suporte a qualquer tipo primitivo 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

Nome	Tipo	Description
201 Created	DeviceCommand	Êxito
Other Status Codes	Error	Uma resposta de erro recebida do Serviço do IoT Central. Headers x-ms-error-code: string

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory

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

Scopes

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

Send command

Sample Request

HTTP

POST https://appsubdomain.azureiotcentral.com/api/devices/mx1/components/Thermostat_1o/commands/CoolDown?api-version=2022-07-31

{
  "request": {
    "tempVal": 30
  }
}

Sample Response

Status code:

201

{}

Definições

Nome	Description
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.

Nome	Tipo	Description
connectionTimeout	integer	Tempo limite da conexão em segundos para aguardar um dispositivo desconectado ficar online. O padrão é 0 segundo.
id	string	A ID da solicitação da execução do comando do dispositivo.
request		O conteúdo do comando do dispositivo dá suporte a qualquer tipo primitivo ou objeto.
response		O conteúdo da resposta de comando do dispositivo dá suporte a qualquer tipo primitivo ou objeto.
responseCode	integer	O código status da resposta do 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.

Nome	Tipo	Description
error	ErrorDetails	Detalhes do erro da solicitação atual.

ErrorDetails

As informações detalhadas do erro.

Nome	Tipo	Description
code	string	Código do erro.
message	string	Detalhes da mensagem de erro.
requestId	string	ID de correlação da solicitação atual.
time	string	A hora em que a solicitação de erro falhou.