Devices - Run Command

Service:

IoT Central

Version d'API:

2022-07-31

Exécuter une commande d’appareil
Exécutez une commande sur un appareil.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
baseDomain	path	True	string	Domaine de base pour toutes les demandes de service Azure IoT Central.
commandName	path	True	string	Nom de cette commande d’appareil.
deviceId	path	True	string	ID unique de l’appareil.
subdomain	path	True	string	Sous-domaine de l’application.
api-version	query	True	string	Version de l’API appelée.

Corps de la demande

Nom	Type	Description
connectionTimeout	integer (int32) minimum: 0 maximum: 30	Délai d’expiration de connexion en secondes pour attendre qu’un appareil déconnecté soit mis en ligne. La valeur par défaut est de 0 secondes.
request		Charge utile pour la commande de l’appareil, prend en charge tous les types primitifs ou tous les objets.
responseTimeout	integer (int32) minimum: 5 maximum: 30	Délai d’expiration de réponse en secondes pour attendre la fin d’une commande sur un appareil. La valeur par défaut est de 30 secondes.

Réponses

Nom	Type	Description
201 Created	DeviceCommand	Succès
Other Status Codes	Error	Réponse d’erreur reçue du service IoT Central. En-têtes x-ms-error-code: string

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Exemples

Send command

Exemple de requête

HTTP

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

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

Exemple de réponse

Code d’état:

201

{}

Définitions

Nom	Description
DeviceCommand	Définition de la commande de l’appareil.
Error	Définition de l’erreur de réponse.
ErrorDetails	Informations détaillées de l’erreur.

DeviceCommand

Object

Définition de la commande de l’appareil.

Nom	Type	Description
connectionTimeout	integer (int32) minimum: 0 maximum: 30	Délai d’expiration de connexion en secondes pour attendre qu’un appareil déconnecté soit mis en ligne. La valeur par défaut est de 0 secondes.
id	string	ID de demande de l’exécution de la commande de l’appareil.
request		Charge utile pour la commande de l’appareil, prend en charge tous les types primitifs ou tous les objets.
response		Charge utile de la réponse de commande de l’appareil, prise en charge des types primitifs ou des objets.
responseCode	integer (int32)	Code d’état de la réponse de commande de l’appareil.
responseTimeout	integer (int32) minimum: 5 maximum: 30	Délai d’expiration de réponse en secondes pour attendre la fin d’une commande sur un appareil. La valeur par défaut est de 30 secondes.

Error

Object

Définition de l’erreur de réponse.

Nom	Type	Description
error	ErrorDetails	Détails de l’erreur pour la requête actuelle.

ErrorDetails

Object

Informations détaillées de l’erreur.

Nom	Type	Description
code	string	Code d’erreur.
message	string	Détails du message d’erreur.
requestId	string	ID de corrélation pour la requête actuelle.
time	string (date-time-rfc1123)	Heure à laquelle la demande d’erreur a échoué.