Devices - Run Command

Serviço:

IoT Central

Versão da API:

2022-07-31

Executar um comando de dispositivo
Execute um comando em um dispositivo.

POST https://{subdomain}.{baseDomain}/api/devices/{deviceId}/commands/{commandName}?api-version=2022-07-31

Parâmetros do URI

Name	Em	Necessá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.
deviceId	path	True	string	ID exclusivo 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 do Pedido

Name	Tipo	Description
connectionTimeout	integer (int32) minimum: 0 maximum: 30	Tempo limite de conexão em segundos para aguardar até que um dispositivo desconectado fique online. O padrão é 0 segundos.
request		A carga útil para o comando device, suporta qualquer tipo primitivo ou objeto.
responseTimeout	integer (int32) minimum: 5 maximum: 30	Tempo limite de resposta em segundos para aguardar a conclusão de um comando em um dispositivo. O padrão é de 30 segundos.

Respostas

Name	Tipo	Description
201 Created	DeviceCommand	Sucesso
Other Status Codes	Error	Uma resposta de erro recebida do Serviço Central da IoT. Cabeçalhos x-ms-error-code: string

Segurança

azure_auth

Azure Ative Directory OAuth2 Flow

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

Send command

Pedido de amostra

HTTP

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

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

Resposta da amostra

Código de estado:

201

{}

Definições

Name	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

Object

A definição de comando do dispositivo.

Name	Tipo	Description
connectionTimeout	integer (int32) minimum: 0 maximum: 30	Tempo limite de conexão em segundos para aguardar até que um dispositivo desconectado fique online. O padrão é 0 segundos.
id	string	A ID da solicitação da execução do comando do dispositivo.
request		A carga útil para o comando device, suporta qualquer tipo primitivo ou objeto.
response		A carga útil da resposta do comando do dispositivo, suporta qualquer tipo primitivo ou objeto.
responseCode	integer (int32)	O código de status da resposta do comando do dispositivo.
responseTimeout	integer (int32) minimum: 5 maximum: 30	Tempo limite de resposta em segundos para aguardar a conclusão de um comando em um dispositivo. O padrão é de 30 segundos.

Error

Object

A definição de erro de resposta.

Name	Tipo	Description
error	ErrorDetails	Detalhes do erro para a solicitação atual.

ErrorDetails

Object

As informações detalhadas do erro.

Name	Tipo	Description
code	string	Código de erro.
message	string	Detalhes da mensagem de erro.
requestId	string	ID de correlação para a solicitação atual.
time	string (date-time-rfc1123)	A hora em que a solicitação de erro falhou.