Azure IoT Central V3 (préversion)

Azure IoT Central facilite la connexion, la surveillance et la gestion de vos appareils IoT à grande échelle. Avec le connecteur IoT Central V3, vous pouvez déclencher des flux de travail lorsqu’une règle a déclenché et effectuer des actions en exécutant des commandes, en mettant à jour les propriétés, en obtenant des données de télémétrie à partir d’appareils, etc. Utilisez ce connecteur avec votre application Azure IoT Central V3.

Ce connecteur est disponible dans les produits et régions suivants :

Service	classe	Régions
Copilot Studio	Premium	Toutes les régions Power Automate , à l’exception des éléments suivants : - Us Government (GCC) - Us Government (GCC High) - China Cloud géré par 21Vianet - Us Department of Defense (DoD)
Applications logiques	Norme	Toutes les régions Logic Apps , à l’exception des suivantes : - Régions Azure Government - Régions Azure Chine - Us Department of Defense (DoD)
Power Apps	Premium	Toutes les régions Power Apps , à l’exception des suivantes : - Us Government (GCC) - Us Government (GCC High) - China Cloud géré par 21Vianet - Us Department of Defense (DoD)
Power Automate	Premium	Toutes les régions Power Automate , à l’exception des éléments suivants : - Us Government (GCC) - Us Government (GCC High) - China Cloud géré par 21Vianet - Us Department of Defense (DoD)

Contact
Nom	Support technique Azure IoT Central
URL	https://aka.ms/iotcentral-create-technical-support-ticket-trial

Métadonnées du connecteur
Éditeur	Microsoft Corporation
Site internet	https://azure.microsoft.com/services/iot-central/
Politique de confidentialité	https://privacy.microsoft.com
Catégories	Internet des objets

Le connecteur Azure IoT Central V3 peut être utilisé pour connecter votre application Azure IoT Central V3 à vos workflows. Vous pouvez utiliser le connecteur pour exécuter des flux de travail lorsqu’une règle est déclenchée. Vous pouvez l’utiliser pour obtenir les dernières informations de vos appareils IoT, telles que les données de télémétrie et les propriétés. Vous pouvez également l’utiliser pour mettre à jour vos appareils IoT en envoyant des commandes et en mettant à jour les sites appropriés.

Prerequisites

Vous devez être un utilisateur dans une application Azure IoT Central V3 pay-as-You-Go pour utiliser ce connecteur.
Vous devez utiliser un compte professionnel ou scolaire Microsoft Entra ID.

Comment obtenir des informations d’identification

Pour ajouter ce connecteur à votre flux de travail, vous devez d’abord vous connecter au compte professionnel ou scolaire Microsoft Entra ID qui est un utilisateur de l’application Azure IoT Central à laquelle vous souhaitez vous connecter.

Notes de publication

Septembre 2021

Le connecteur Azure IoT Central V3 a maintenant été mis à jour pour s’aligner sur notre surface d’API REST 1.0 généralement disponible. Toutes les actions de connecteur prennent désormais en charge notre format DTDLv2 et la prise en charge des modèles DTDLv1 est déconseillée.
Les actions à , Get/Update device propertieset Get device telemetry value ont été mises à Run a device commandjour pour ajouter la prise en charge aux dernières fonctionnalités de modèle d’appareil dans Azure IoT Central. Ces actions prennent désormais en charge les fonctionnalités racine et composant.
Un nouvel ensemble d’actions de module d’appareil a été ajouté. Ces actions permettent de créer des flux de travail qui interagissent avec des commandes, des propriétés, des télémétries des modules d’appareil et des composants de module.
Actions à Get/Create/Update/Delete a device mettre à jour pour s’aligner sur la dernière API REST Azure IoT Central.
Les actions Get device cloud properties et Update device cloud properties font désormais partie de Get device properties et Update device properties. Les nouvelles actions permettent aux flux de travail d’interagir simultanément avec les propriétés de l’appareil et les propriétés cloud.

Avis de dépréciation : à la fin de CY21, les actions marquées comme déconseillées dans la liste ci-dessous ne seront plus disponibles lors de la création de nouveaux flux de travail. Les flux de travail existants faisant référence à ces actions continueront de fonctionner jusqu’en mars 2022. Nous vous encourageons à mettre à jour vos flux de travail pour tirer parti des actions nouvellement annoncées qui sont désormais prises en charge dans Azure IoT Central.

Novembre 2021

De nouvelles actions ont été ajoutées pour répertorier les appareils et les modèles d’appareil pour une application Azure IoT Central. Ces actions incluent la prise en charge de la pagination.
Un nouvel ensemble d’actions de gestion des utilisateurs a été ajouté au connecteur, ce qui permet aux flux de travail de créer, mettre à jour, répertorier et supprimer des utilisateurs d’une application.
Les flux de travail peuvent désormais obtenir la dernière exécution d’une commande d’appareil à l’aide des nouvelles Get device command response actions. Cet ensemble d’actions prend en charge les commandes racine, composant et module.

Problèmes connus et limitations

Pour utiliser ce connecteur dans Microsoft Power Automate, vous devez être connecté à l’application IoT Central au moins une fois. Sinon, l’application n’apparaît pas dans la liste déroulante Application
Les comptes personnels Microsoft (tels que @hotmail.com, domaines@live.com@outlook.com) ne sont pas pris en charge pour se connecter au connecteur IoT Central. Vous devez utiliser un compte professionnel ou scolaire Microsoft Entra ID.

Création d’une connexion

Le connecteur prend en charge les types d’authentification suivants :


Identifiants	Credentials	Toutes les régions	Non partageable
Valeur par défaut [DÉCONSEILLÉE]	Cette option concerne uniquement les connexions plus anciennes sans type d’authentification explicite et est fournie uniquement pour la compatibilité descendante.	Toutes les régions	Non partageable

Credentials

ID d’authentification : 1stparty

Applicable : Toutes les régions

Credentials

Cette connexion n’est pas partageable. Si l’application power est partagée avec un autre utilisateur, un autre utilisateur est invité à créer une connexion explicitement.

Valeur par défaut [DÉCONSEILLÉE]

Applicable : Toutes les régions

Cette option concerne uniquement les connexions plus anciennes sans type d’authentification explicite et est fournie uniquement pour la compatibilité descendante.

Cette connexion n’est pas partageable. Si l’application power est partagée avec un autre utilisateur, un autre utilisateur est invité à créer une connexion explicitement.

Limitations

Nom	Appels	Période de renouvellement
Appels d’API par connexion	100	60 secondes

Actions

Arrêter un travail en cours d’exécution	Arrêtez l’exécution d’un travail en cours d’exécution.
Créer ou mettre à jour un appareil	Créez un appareil ou mettez à jour un appareil existant par ID d’appareil.
Créer ou mettre à jour un appareil (déconseillé)	Créez un appareil ou mettez à jour un appareil existant par ID d’appareil. (déconseillé)
Créer ou mettre à jour un appareil (déconseillé)	Créez un appareil ou mettez à jour un appareil existant par ID d’appareil (déconseillé).
Créer un groupe d'appareils	Créez ou mettez à jour un groupe d’appareils.
Créer un travail	Créez et exécutez un travail via sa définition de travail.
Créer un utilisateur	Créer un utilisateur dans l’application
Créer une organisation	Créer une organisation.
Créer une relation d’appareil	Créez une relation d’appareil entre l’appareil donné et un nouvel appareil en fonction d’un ID d’appareil et d’un ID de relation.
Créer une tâche planifiée	Créez et exécutez un travail planifié via sa définition de travail.
Exécuter une commande de composant	Exécutez une commande sur un composant.
Exécuter une commande de composant de module	Exécutez une commande sur un composant de module.
Exécuter une commande de module	Exécutez une commande sur un module.
Exécuter une commande d’appareil	Exécutez une commande sur un appareil.
Exécuter une commande d’appareil (déconseillée)	Exécutez une commande sur un appareil (déconseillé).
Liste des emplois	Obtenez la liste des travaux dans une application.
Lister les relations	Répertorier toutes les relations basées sur l’ID d’appareil.
Mettre à jour l'utilisateur	Mettre à jour un utilisateur dans l’application via un correctif
Mettre à jour les propriétés cloud de l’appareil (déconseillées)	Mettez à jour toutes les valeurs de propriété cloud d’un appareil par ID d’appareil (déconseillé).
Mettre à jour les propriétés de l’appareil	Mettez à jour toutes les valeurs de propriété d’un appareil par ID d’appareil.
Mettre à jour les propriétés de l’appareil (déconseillées)	Mettez à jour toutes les valeurs de propriété d’un appareil par ID d’appareil (déconseillé).
Mettre à jour les propriétés de module	Mettez à jour toutes les valeurs de propriété d’un module.
Mettre à jour un travail planifié	Mettez à jour un travail planifié existant par ID.
Mettre à jour une relation d’appareil	Mettez à jour une relation d’appareil existante entre l’appareil donné et un nouvel appareil en fonction d’un ID d’appareil et d’un ID de relation.
Obtenir des appareils par ID de groupe d’appareils	Obtenez la liste des appareils d’un groupe d’appareils dans une application.
Obtenir des travaux par ID de travail planifié	Obtenez la liste des travaux pour une définition de travail planifiée.
Obtenir la réponse de commande du composant module	Obtenez la dernière réponse pour une commande de composant de module.
Obtenir la réponse de commande du module	Obtenir la dernière réponse d’une commande de module d’appareil
Obtenir la réponse de la commande de composant	Obtenez la dernière réponse pour une commande de composant d’appareil.
Obtenir la réponse de la commande d’appareil	Obtenez la dernière réponse d’une commande d’appareil.
Obtenir la valeur de télémétrie de l’appareil	Obtenez la dernière valeur de télémétrie d’un appareil.
Obtenir la valeur de télémétrie de l’appareil (déconseillée)	Obtenez la dernière valeur de télémétrie à partir d’un appareil (déconseillé).
Obtenir la valeur de télémétrie des composants	Obtenez la dernière valeur de télémétrie d’un composant.
Obtenir la valeur de télémétrie du composant module	Obtenez la dernière valeur de télémétrie à partir d’un composant de module.
Obtenir la valeur de télémétrie du module	Obtenez la dernière valeur de télémétrie à partir d’un module.
Obtenir les propriétés cloud de l’appareil (déconseillées)	Obtenez toutes les valeurs de propriété cloud d’un appareil par ID d’appareil (déconseillé).
Obtenir les propriétés de l’appareil	Obtenez toutes les valeurs de propriété d’un appareil par ID d’appareil.
Obtenir les propriétés de l’appareil (déconseillées)	Obtient toutes les valeurs de propriété d’un appareil par ID d’appareil (déconseillé).
Obtenir les propriétés du module	Obtient toutes les valeurs de propriété d’un module.
Obtenir les états de l’appareil	Obtenez la liste des états d’appareil individuels par ID de travail.
Obtenir un appareil par ID (déconseillé)	Obtenez des détails sur un appareil existant par ID d’appareil (déconseillé).
Obtenir un appareil via identifiant	Obtenez des détails sur un appareil existant par ID d’appareil.
Obtenir un groupe d’appareils	Obtenez des détails sur un groupe d’appareils existant par ID.
Obtenir un modèle d’appareil via son ID	Obtenez des détails sur un modèle d’appareil existant par ID.
Obtenir un rôle	Obtenez un rôle par ID.
Obtenir un travail	Obtenez des détails sur un travail existant par ID.
Obtenir un travail planifié	Obtenez des détails sur un travail planifié existant par ID.
Obtenir un utilisateur	Obtenir un utilisateur par ID
Obtenir une organisation	Obtenez des détails sur une organisation existante par ID.
Obtenir une relation d’appareil	Obtenez des détails sur une relation d’appareil existante par ID d’appareil et par ID de relation.
Reprendre un travail arrêté	Reprendre l’exécution d’un travail arrêté existant.
Reprendre un travail sur les appareils ayant échoué	Exécutez une réexécution d’un travail existant sur tous les appareils ayant échoué.
Répertorier des utilisateurs	Obtenir la liste des utilisateurs dans une application
Répertorier les appareils	Obtenez la liste des appareils dans une application.
Répertorier les groupes d’appareils	Obtenez la liste des groupes d’appareils dans une application.
Répertorier les modèles d’appareils	Obtenez la liste des modèles d’appareil dans une application.
Répertorier les organisations	Obtenez la liste des organisations dans une application.
Répertorier les rôles	Obtenez la liste des rôles dans une application.
Répertorier les travaux planifiés	Obtenez la liste des travaux planifiés dans une application.
Supprimer l’utilisateur	Supprimer un utilisateur
Supprimer un appareil	Supprimez un appareil existant par ID d’appareil.
Supprimer un appareil (déconseillé)	Supprimez un appareil existant par ID d’appareil (déconseillé).
Supprimer un groupe d’appareils	Supprimer un groupe d’appareils existant par ID
Supprimer un modèle d’appareil	Supprimez un modèle d’appareil existant par ID.
Supprimer un travail planifié	Supprimez un travail planifié existant par ID.
Supprimer une organisation	Supprimer une organisation existante par ID
Supprimer une relation d’appareil	Supprimez une relation d’appareil existante par ID d’appareil et ID de relation.

Arrêter un travail en cours d’exécution

ID d’opération :: Jobs_Stop

Arrêtez l’exécution d’un travail en cours d’exécution.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Application	application	True	string	ID unique de l’application.
ID du travail	job_id	True	string	ID unique du travail.

Créer ou mettre à jour un appareil

ID d’opération :: Devices_Set_V2

Créez un appareil ou mettez à jour un appareil existant par ID d’appareil.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Application	application	True	string	ID unique de l’application.
ID d’appareil	device_id	True	string	ID unique de l’appareil.
ID d’appareil	id		string	ID unique de l’appareil.
Nom de l’appareil	displayName		string	Nom complet de l’appareil.
Modèle d’appareil	template		string	Définition du modèle d’appareil pour l’appareil.
Simulé	simulated		boolean	Indique si l’appareil est simulé.
Enabled	enabled		boolean	Indique si la connexion de l’appareil à IoT Central a été activée.
Organizations	organizations		array of string	Liste des organisations de l’appareil, une seule organisation est prise en charge aujourd’hui, plusieurs organisations seront bientôt prises en charge.
approvisionné	provisioned		boolean	Indique si les ressources ont été allouées pour l’appareil.

Retours

Corps: DeviceV2

Créer ou mettre à jour un appareil (déconseillé)

ID d’opération :: Devices_Set_V1

Créez un appareil ou mettez à jour un appareil existant par ID d’appareil. (déconseillé)

Paramètres

Nom	Clé	Obligatoire	Type	Description
Application	application	True	string	ID unique de l’application.
ID d’appareil	device_id	True	string	ID unique de l’appareil.
ID d’appareil	id		string	ID unique de l’appareil.
Nom de l’appareil	displayName		string	Nom complet de l’appareil.
Modèle d’appareil	template		string	Définition du modèle d’appareil pour l’appareil.
Simulé	simulated		boolean	Indique si l’appareil est simulé.
Enabled	enabled		boolean	Indique si la connexion de l’appareil à IoT Central a été activée.
approvisionné	provisioned		boolean	Indique si les ressources ont été allouées pour l’appareil.

Retours

Corps: DeviceV1

Créer ou mettre à jour un appareil (déconseillé)

ID d’opération :: Devices_Set

Créez un appareil ou mettez à jour un appareil existant par ID d’appareil (déconseillé).

Paramètres

Nom	Clé	Obligatoire	Type	Description
Application	application	True	string	ID unique de l’application.
ID d’appareil	device_id	True	string	ID unique de l’appareil.
ID d’appareil	id		string	ID unique de l’appareil.
Nom de l’appareil	displayName		string	Nom complet de l’appareil.
Modèle d’appareil	instanceOf		string	Définition du modèle d’appareil pour l’appareil.
Simulé	simulated		boolean	Indique si l’appareil est simulé.
Approuvé	approved		boolean	Indique si l’appareil a été approuvé pour se connecter à IoT Central.
approvisionné	provisioned		boolean	Indique si les ressources ont été allouées pour l’appareil.

Retours

Corps: Device

Créer un groupe d'appareils

ID d’opération :: DeviceGroups_Set

Créez ou mettez à jour un groupe d’appareils.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Application	application	True	string	ID unique de l’application.
ID de groupe d’appareils	device_group_id	True	string	ID unique du groupe d’appareils.
ID de groupe d’appareils	id		string	ID unique du groupe d’appareils.
Nom d’affichage	displayName	True	string	Nom complet du groupe d’appareils.
Filter	filter	True	string	Interrogez la définition des appareils qui doivent se trouver dans ce groupe.
Descriptif	description		string	Résumé court du groupe d’appareils.
ETag	etag		string	ETag utilisé pour empêcher le conflit dans les mises à jour de groupe d’appareils.
Organizations	organizations		array of string	Liste des organisations du groupe d’appareils, une seule organisation est prise en charge aujourd’hui, plusieurs organisations seront bientôt prises en charge.

Retours

Définition du groupe d’appareils.

Corps: DeviceGroup

Créer un travail

ID d’opération :: Jobs_Set

Créez et exécutez un travail via sa définition de travail.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Application	application	True	string	ID unique de l’application.
ID du travail	job_id	True	string	ID unique du travail.
Type de tâche	job_type		string	Type du travail.
Corps	body	True	dynamic	Corps de la création du travail.

Retours

Les sorties de cette opération sont dynamiques.

Créer un utilisateur

ID d’opération :: Users_Create_V1

Créer un utilisateur dans l’application

Paramètres

Nom	Clé	Obligatoire	Type	Description
Application	application	True	string	ID unique de l’application.
Utilisateur	user_id	True	string	ID unique de l’utilisateur.
Type d’utilisateur	user_type		string	Type de l’utilisateur.
Corps	body	True	dynamic	Corps de la création de l’utilisateur.

Retours

Les sorties de cette opération sont dynamiques.

Créer une organisation

ID d’opération :: Organizations_Set

Créer une organisation.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Application	application	True	string	ID unique de l’application.
ID d’organisation	organization_id	True	string	ID unique de l’organisation.
ID d’organisation	id		string	ID unique de l’organisation.
Nom de l’organisation	displayName		string	Nom complet de l’organisation.
Parent	parent		string	Nom complet de l’organisation parente.

Retours

Corps: Organization

Créer une relation d’appareil

ID d’opération :: DeviceRelationships_Set

Créez une relation d’appareil entre l’appareil donné et un nouvel appareil en fonction d’un ID d’appareil et d’un ID de relation.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Application	application	True	string	ID unique de l’application.
ID de relation	relationship_id	True	string	ID unique de la relation d’appareil.
ID d’appareil	device_id	True	string	ID unique de l’appareil.
ID de relation d’appareil	id		string	ID unique de la relation d’appareil.
ID cible de relation d’appareil	target	True	string	ID d’appareil de l’appareil source (enfant).

Retours

Corps: DeviceRelationshipStatic

Créer une tâche planifiée

ID d’opération :: ScheduledJobs_Set

Créez et exécutez un travail planifié via sa définition de travail.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Application	application	True	string	ID unique de l’application.
ID de travail planifié	scheduled_job_id	True	string	ID unique du travail planifié.
Type de tâche	job_type		string	Type du travail.
Type de fin de planification	scheduled_job_end_type		string	Comment le travail planifié doit se terminer (non appliqué aux migrations de modèles d’appareil).
Corps	body	True	dynamic	Corps de création du travail planifié.

Retours

Les sorties de cette opération sont dynamiques.

Exécuter une commande de composant

ID d’opération :: Devices_RunComponentCommand_V1

Exécutez une commande sur un composant.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Application	application	True	string	ID unique de l’application.
ID d’appareil	device_id	True	string	ID unique de l’appareil.
Composant d’appareil	component_name	True	string	Nom du composant d’appareil.
Commande d’appareil	command_name	True	string	Nom de cette commande d’appareil.
Modèle d’appareil	template		string	Définition du modèle d’appareil pour l’appareil.
body	body	True	dynamic	Corps de la commande de l’appareil.

Retours

Les sorties de cette opération sont dynamiques.

Exécuter une commande de composant de module

ID d’opération :: Devices_RunModuleComponentCommand_V1

Exécutez une commande sur un composant de module.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Application	application	True	string	ID unique de l’application.
ID d’appareil	device_id	True	string	ID unique de l’appareil.
Module d’appareil	module	True	string	Nom du module d’appareil.
Composant d’appareil	component_name	True	string	Nom du composant d’appareil.
Commande d’appareil	command_name	True	string	Nom de cette commande d’appareil.
Modèle d’appareil	template		string	Définition du modèle d’appareil pour l’appareil.
body	body	True	dynamic	Corps de la commande de l’appareil.

Retours

Les sorties de cette opération sont dynamiques.

Exécuter une commande de module

ID d’opération :: Devices_RunModuleCommand_V1

Exécutez une commande sur un module.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Application	application	True	string	ID unique de l’application.
ID d’appareil	device_id	True	string	ID unique de l’appareil.
Module d’appareil	module	True	string	Nom du module d’appareil.
Commande d’appareil	command_name	True	string	Nom de cette commande d’appareil.
Modèle d’appareil	template		string	Définition du modèle d’appareil pour l’appareil.
body	body	True	dynamic	Corps de la commande de l’appareil.

Retours

Les sorties de cette opération sont dynamiques.

Exécuter une commande d’appareil

ID d’opération :: Devices_RunCommand_V1

Exécutez une commande sur un appareil.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Application	application	True	string	ID unique de l’application.
ID d’appareil	device_id	True	string	ID unique de l’appareil.
Commande d’appareil	command_name	True	string	Nom de cette commande d’appareil.
Modèle d’appareil	template		string	Définition du modèle d’appareil pour l’appareil.
body	body	True	dynamic	Corps de la commande de l’appareil.

Retours

Les sorties de cette opération sont dynamiques.

Exécuter une commande d’appareil (déconseillée)

ID d’opération :: Devices_ExecuteComponentCommand

Exécutez une commande sur un appareil (déconseillé).

Paramètres

Nom	Clé	Obligatoire	Type	Description
Application	application	True	string	ID unique de l’application.
ID d’appareil	device_id	True	string	ID unique de l’appareil.
Composant d’appareil	component_name	True	string	Nom du composant d’appareil.
Commande d’appareil	command_name	True	string	Nom de cette commande d’appareil.
ID de modèle d’appareil	instanceOf		string	Définition du modèle d’appareil pour l’appareil.
body	body	True	dynamic	Corps de la commande de l’appareil.

Retours

Les sorties de cette opération sont dynamiques.

Liste des emplois

ID d’opération :: Jobs_List

Obtenez la liste des travaux dans une application.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Application	application	True	string	ID unique de l’application.

Retours

Résultats paginés des travaux.

Corps: JobCollection

Lister les relations

ID d’opération :: DeviceRelationships_List

Répertorier toutes les relations basées sur l’ID d’appareil.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Application	application	True	string	ID unique de l’application.
ID d’appareil	device_id	True	string	ID unique de l’appareil.

Retours

Corps: DeviceRelationshipCollection

Mettre à jour l'utilisateur

ID d’opération :: Users_Update_V1

Mettre à jour un utilisateur dans l’application via un correctif

Paramètres

Nom	Clé	Obligatoire	Type	Description
Application	application	True	string	ID unique de l’application.
Utilisateur	user_id	True	string	ID unique de l’utilisateur.
Type d’utilisateur	user_type		string	Type de l’utilisateur.
Corps	body	True	dynamic	Corps de mise à jour de l’utilisateur.

Retours

Les sorties de cette opération sont dynamiques.

Mettre à jour les propriétés cloud de l’appareil (déconseillées)

ID d’opération :: Devices_UpdateCloudProperties

Mettez à jour toutes les valeurs de propriété cloud d’un appareil par ID d’appareil (déconseillé).

Paramètres

Nom	Clé	Obligatoire	Type	Description
Application	application	True	string	ID unique de l’application.
ID d’appareil	device_id	True	string	ID unique de l’appareil.
ID de modèle d’appareil	instanceOf		string	Définition du modèle d’appareil pour l’appareil.
body	body	True	dynamic	Propriétés de l’appareil.

Retours

Les sorties de cette opération sont dynamiques.

Mettre à jour les propriétés de l’appareil

ID d’opération :: Devices_UpdateProperties_V1

Mettez à jour toutes les valeurs de propriété d’un appareil par ID d’appareil.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Application	application	True	string	ID unique de l’application.
ID d’appareil	device_id	True	string	ID unique de l’appareil.
Modèle d’appareil	template		string	Définition du modèle d’appareil pour l’appareil.
body	body	True	dynamic	Propriétés de l’appareil.

Retours

Les sorties de cette opération sont dynamiques.

Mettre à jour les propriétés de l’appareil (déconseillées)

ID d’opération :: Devices_UpdateProperties

Mettez à jour toutes les valeurs de propriété d’un appareil par ID d’appareil (déconseillé).

Paramètres

Nom	Clé	Obligatoire	Type	Description
Application	application	True	string	ID unique de l’application.
ID d’appareil	device_id	True	string	ID unique de l’appareil.
ID de modèle d’appareil	instanceOf		string	Définition du modèle d’appareil pour l’appareil.
body	body	True	dynamic	Propriétés de l’appareil.

Retours

Les sorties de cette opération sont dynamiques.

Mettre à jour les propriétés de module

ID d’opération :: Devices_UpdateModuleProperties_V1

Mettez à jour toutes les valeurs de propriété d’un module.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Application	application	True	string	ID unique de l’application.
ID d’appareil	device_id	True	string	ID unique de l’appareil.
Module d’appareil	module	True	string	Nom du module d’appareil.
Modèle d’appareil	template		string	Définition du modèle d’appareil pour l’appareil.
body	body	True	dynamic	Propriétés de l’appareil.

Retours

Les sorties de cette opération sont dynamiques.

Mettre à jour un travail planifié

ID d’opération :: ScheduledJobs_Update

Mettez à jour un travail planifié existant par ID.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Application	application	True	string	ID unique de l’application.
ID de travail planifié	scheduled_job_id	True	string	ID unique du travail planifié.
Type de fin de planification	scheduled_job_end_type		string	Comment le travail planifié doit se terminer (non appliqué aux migrations de modèles d’appareil).
Corps	body	True	dynamic	Corps de création du travail planifié.

Retours

Définition de travail planifiée.

Corps: ScheduledJobStatic

Mettre à jour une relation d’appareil

ID d’opération :: DeviceRelationships_Update

Mettez à jour une relation d’appareil existante entre l’appareil donné et un nouvel appareil en fonction d’un ID d’appareil et d’un ID de relation.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Application	application	True	string	ID unique de l’application.
ID d’appareil	device_id	True	string	ID unique de l’appareil.
ID de relation	relationship_id	True	string	ID unique de la relation d’appareil.
ID de relation d’appareil	id		string	ID unique de la relation d’appareil.
ID cible de relation d’appareil	target	True	string	ID d’appareil de l’appareil source (enfant).

Retours

Corps: DeviceRelationshipStatic

Obtenir des appareils par ID de groupe d’appareils

ID d’opération :: DeviceGroups_GetDevices

Obtenez la liste des appareils d’un groupe d’appareils dans une application.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Application	application	True	string	ID unique de l’application.
ID de groupe d’appareils	device_group_id	True	string	ID unique du groupe d’appareils.

Retours

Résultats paginés des appareils appartenant au groupe d’appareils.

Corps: DeviceGroupDeviceCollection

Obtenir des travaux par ID de travail planifié

ID d’opération :: ScheduledJobs_ListJobs

Obtenez la liste des travaux pour une définition de travail planifiée.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Application	application	True	string	ID unique de l’application.
ID de travail planifié	scheduled_job_id	True	string	ID unique du travail planifié.

Retours

Résultats paginés des définitions de travaux appartenant à un travail planifié.

Corps: ScheduledJobJobCollection

Obtenir la réponse de commande du composant module

ID d’opération :: Devices_GetModuleComponentCommandResponse_V1

Obtenez la dernière réponse pour une commande de composant de module.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Application	application	True	string	ID unique de l’application.
ID d’appareil	device_id	True	string	ID unique de l’appareil.
Module d’appareil	module	True	string	Nom du module d’appareil.
Composant d’appareil	component_name	True	string	Nom du composant d’appareil.
Commande d’appareil	command_name	True	string	Nom de cette commande d’appareil.
Modèle d’appareil	template		string	Définition du modèle d’appareil pour l’appareil.

Retours

Les sorties de cette opération sont dynamiques.

Obtenir la réponse de commande du module

ID d’opération :: Devices_GetModuleCommandResponse_V1

Obtenir la dernière réponse d’une commande de module d’appareil

Paramètres

Nom	Clé	Obligatoire	Type	Description
Application	application	True	string	ID unique de l’application.
ID d’appareil	device_id	True	string	ID unique de l’appareil.
Module d’appareil	module	True	string	Nom du module d’appareil.
Commande d’appareil	command_name	True	string	Nom de cette commande d’appareil.
Modèle d’appareil	template		string	Définition du modèle d’appareil pour l’appareil.

Retours

Les sorties de cette opération sont dynamiques.

Obtenir la réponse de la commande de composant

ID d’opération :: Devices_GetComponentCommandResponse_V1

Obtenez la dernière réponse pour une commande de composant d’appareil.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Application	application	True	string	ID unique de l’application.
ID d’appareil	device_id	True	string	ID unique de l’appareil.
Composant d’appareil	component_name	True	string	Nom du composant d’appareil.
Commande d’appareil	command_name	True	string	Nom de cette commande d’appareil.
Modèle d’appareil	template		string	Définition du modèle d’appareil pour l’appareil.

Retours

Les sorties de cette opération sont dynamiques.

Obtenir la réponse de la commande d’appareil

ID d’opération :: Devices_GetCommandResponse_V1

Obtenez la dernière réponse d’une commande d’appareil.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Application	application	True	string	ID unique de l’application.
ID d’appareil	device_id	True	string	ID unique de l’appareil.
Commande d’appareil	command_name	True	string	Nom de cette commande d’appareil.
Modèle d’appareil	template		string	Définition du modèle d’appareil pour l’appareil.

Retours

Les sorties de cette opération sont dynamiques.

Obtenir la valeur de télémétrie de l’appareil

ID d’opération :: Devices_GetTelemetryValue_V1

Obtenez la dernière valeur de télémétrie d’un appareil.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Application	application	True	string	ID unique de l’application.
ID d’appareil	device_id	True	string	ID unique de l’appareil.
Télémétrie de l’appareil	telemetry_name	True	string	Nom de cette télémétrie d’appareil.
Modèle d’appareil	template		string	Définition du modèle d’appareil pour l’appareil.

Retours

Les sorties de cette opération sont dynamiques.

Obtenir la valeur de télémétrie de l’appareil (déconseillée)

ID d’opération :: Devices_GetComponentTelemetryValue

Obtenez la dernière valeur de télémétrie à partir d’un appareil (déconseillé).

Paramètres

Nom	Clé	Obligatoire	Type	Description
Application	application	True	string	ID unique de l’application.
ID d’appareil	device_id	True	string	ID unique de l’appareil.
Composant d’appareil	component_name	True	string	Nom du composant d’appareil.
Télémétrie de l’appareil	telemetry_name	True	string	Nom de cette télémétrie d’appareil.
ID de modèle d’appareil	instanceOf		string	Définition du modèle d’appareil pour l’appareil.

Retours

Les sorties de cette opération sont dynamiques.

Obtenir la valeur de télémétrie des composants

ID d’opération :: Devices_GetComponentTelemetryValue_V1

Obtenez la dernière valeur de télémétrie d’un composant.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Application	application	True	string	ID unique de l’application.
ID d’appareil	device_id	True	string	ID unique de l’appareil.
Composant d’appareil	component_name	True	string	Nom du composant d’appareil.
Télémétrie de l’appareil	telemetry_name	True	string	Nom de cette télémétrie d’appareil.
Modèle d’appareil	template		string	Définition du modèle d’appareil pour l’appareil.

Retours

Les sorties de cette opération sont dynamiques.

Obtenir la valeur de télémétrie du composant module

ID d’opération :: Devices_GetModuleComponentTelemetryValue_V1

Obtenez la dernière valeur de télémétrie à partir d’un composant de module.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Application	application	True	string	ID unique de l’application.
ID d’appareil	device_id	True	string	ID unique de l’appareil.
Module d’appareil	module	True	string	Nom du module d’appareil.
Composant d’appareil	component_name	True	string	Nom du composant d’appareil.
Télémétrie de l’appareil	telemetry_name	True	string	Nom de cette télémétrie d’appareil.
Modèle d’appareil	template		string	Définition du modèle d’appareil pour l’appareil.

Retours

Les sorties de cette opération sont dynamiques.

Obtenir la valeur de télémétrie du module

ID d’opération :: Devices_GetModuleTelemetryValue_V1

Obtenez la dernière valeur de télémétrie à partir d’un module.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Application	application	True	string	ID unique de l’application.
ID d’appareil	device_id	True	string	ID unique de l’appareil.
Module d’appareil	module	True	string	Nom du module d’appareil.
Télémétrie de l’appareil	telemetry_name	True	string	Nom de cette télémétrie d’appareil.
Modèle d’appareil	template		string	Définition du modèle d’appareil pour l’appareil.

Retours

Les sorties de cette opération sont dynamiques.

Obtenir les propriétés cloud de l’appareil (déconseillées)

ID d’opération :: Devices_GetCloudProperties

Obtenez toutes les valeurs de propriété cloud d’un appareil par ID d’appareil (déconseillé).

Paramètres

Nom	Clé	Obligatoire	Type	Description
Application	application	True	string	ID unique de l’application.
ID d’appareil	device_id	True	string	ID unique de l’appareil.
ID de modèle d’appareil	instanceOf		string	Définition du modèle d’appareil pour l’appareil.

Retours

Les sorties de cette opération sont dynamiques.

Obtenir les propriétés de l’appareil

ID d’opération :: Devices_GetProperties_V1

Obtenez toutes les valeurs de propriété d’un appareil par ID d’appareil.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Application	application	True	string	ID unique de l’application.
ID d’appareil	device_id	True	string	ID unique de l’appareil.
Modèle d’appareil	template		string	Définition du modèle d’appareil pour l’appareil.

Retours

Les sorties de cette opération sont dynamiques.

Obtenir les propriétés de l’appareil (déconseillées)

ID d’opération :: Devices_GetProperties

Obtient toutes les valeurs de propriété d’un appareil par ID d’appareil (déconseillé).

Paramètres

Nom	Clé	Obligatoire	Type	Description
Application	application	True	string	ID unique de l’application.
ID d’appareil	device_id	True	string	ID unique de l’appareil.
ID de modèle d’appareil	instanceOf		string	Définition du modèle d’appareil pour l’appareil.

Retours

Les sorties de cette opération sont dynamiques.

Obtenir les propriétés du module

ID d’opération :: Devices_GetModuleProperties_V1

Obtient toutes les valeurs de propriété d’un module.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Application	application	True	string	ID unique de l’application.
ID d’appareil	device_id	True	string	ID unique de l’appareil.
Module d’appareil	module	True	string	Nom du module d’appareil.
Modèle d’appareil	template		string	Définition du modèle d’appareil pour l’appareil.

Retours

Les sorties de cette opération sont dynamiques.

Obtenir les états de l’appareil

ID d’opération :: Jobs_GetDevices

Obtenez la liste des états d’appareil individuels par ID de travail.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Application	application	True	string	ID unique de l’application.
ID du travail	job_id	True	string	ID unique du travail.

Retours

Résultats paginés des états de l’appareil de travail.

Corps: JobDeviceStatusCollection

Obtenir un appareil par ID (déconseillé)

ID d’opération :: Devices_Get

Obtenez des détails sur un appareil existant par ID d’appareil (déconseillé).

Paramètres

Nom	Clé	Obligatoire	Type	Description
Application	application	True	string	ID unique de l’application.
ID d’appareil	device_id	True	string	ID unique de l’appareil.

Retours

Corps: Device

Obtenir un appareil via identifiant

ID d’opération :: Devices_Get_V1

Obtenez des détails sur un appareil existant par ID d’appareil.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Application	application	True	string	ID unique de l’application.
ID d’appareil	device_id	True	string	ID unique de l’appareil.

Retours

Corps: DeviceV1

Obtenir un groupe d’appareils

ID d’opération :: DeviceGroups_Get

Obtenez des détails sur un groupe d’appareils existant par ID.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Application	application	True	string	ID unique de l’application.
ID de groupe d’appareils	device_group_id	True	string	ID unique du groupe d’appareils.

Retours

Définition du groupe d’appareils.

Corps: DeviceGroup

Obtenir un modèle d’appareil via son ID

ID d’opération :: DeviceTemplates_Get_V1

Obtenez des détails sur un modèle d’appareil existant par ID.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Application	application	True	string	ID unique de l’application.
Template	template_id	True	string	ID unique du modèle.

Retours

Corps: DeviceTemplateV1

Obtenir un rôle

ID d’opération :: Roles_Get_V1

Obtenez un rôle par ID.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Application	application	True	string	ID unique de l’application.
Role	role_id	True	string	ID unique pour le rôle.

Retours

Corps: RoleV1

Obtenir un travail

ID d’opération :: Jobs_Get

Obtenez des détails sur un travail existant par ID.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Application	application	True	string	ID unique de l’application.
ID du travail	job_id	True	string	ID unique du travail.

Retours

Définition du travail.

Corps: JobStatic

Obtenir un travail planifié

ID d’opération :: ScheduledJobs_Get

Obtenez des détails sur un travail planifié existant par ID.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Application	application	True	string	ID unique de l’application.
ID de travail planifié	scheduled_job_id	True	string	ID unique du travail planifié.

Retours

Les sorties de cette opération sont dynamiques.

Obtenir un utilisateur

ID d’opération :: Users_Get_V1

Obtenir un utilisateur par ID

Paramètres

Nom	Clé	Obligatoire	Type	Description
Application	application	True	string	ID unique de l’application.
Utilisateur	user_id	True	string	ID unique de l’utilisateur.

Retours

Corps: UserStaticV1

Obtenir une organisation

ID d’opération :: Organizations_Get

Obtenez des détails sur une organisation existante par ID.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Application	application	True	string	ID unique de l’application.
ID d’organisation	organization_id	True	string	ID unique de l’organisation.

Retours

Corps: Organization

Obtenir une relation d’appareil

ID d’opération :: DeviceRelationships_Get

Obtenez des détails sur une relation d’appareil existante par ID d’appareil et par ID de relation.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Application	application	True	string	ID unique de l’application.
ID d’appareil	device_id	True	string	ID unique de l’appareil.
ID de relation	relationship_id	True	string	ID unique de la relation d’appareil.

Retours

Corps: DeviceRelationshipStatic

Reprendre un travail arrêté

ID d’opération :: Jobs_Resume

Reprendre l’exécution d’un travail arrêté existant.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Application	application	True	string	ID unique de l’application.
ID du travail	job_id	True	string	ID unique du travail.

Reprendre un travail sur les appareils ayant échoué

ID d’opération :: Jobs_Rerun

Exécutez une réexécution d’un travail existant sur tous les appareils ayant échoué.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Application	application	True	string	ID unique de l’application.
ID du travail	job_id	True	string	ID unique du travail.
Réexécuter l’ID	rerun_id	True	string	ID unique de la réexécution.

Retours

Définition du travail.

Corps: JobStatic

Répertorier des utilisateurs

ID d’opération :: Users_List_V1

Obtenir la liste des utilisateurs dans une application

Paramètres

Nom	Clé	Obligatoire	Type	Description
Application	application	True	string	ID unique de l’application.

Retours

Corps: UserCollectionV1

Répertorier les appareils

ID d’opération :: Devices_List_V1

Obtenez la liste des appareils dans une application.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Application	application	True	string	ID unique de l’application.

Retours

Corps: DeviceCollectionV1

Répertorier les groupes d’appareils

ID d’opération :: DeviceGroups_List

Obtenez la liste des groupes d’appareils dans une application.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Application	application	True	string	ID unique de l’application.

Retours

Résultats paginés des groupes d’appareils.

Corps: DeviceGroupCollection

Répertorier les modèles d’appareils

ID d’opération :: DeviceTemplates_List_V1

Obtenez la liste des modèles d’appareil dans une application.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Application	application	True	string	ID unique de l’application.

Retours

Corps: DeviceTemplateCollectionV1

Répertorier les organisations

ID d’opération :: Organizations_List

Obtenez la liste des organisations dans une application.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Application	application	True	string	ID unique de l’application.

Retours

Corps: OrganizationCollection

Répertorier les rôles

ID d’opération :: Roles_List_V1

Obtenez la liste des rôles dans une application.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Application	application	True	string	ID unique de l’application.

Retours

Corps: RoleCollectionV1

Répertorier les travaux planifiés

ID d’opération :: ScheduledJobs_List

Obtenez la liste des travaux planifiés dans une application.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Application	application	True	string	ID unique de l’application.

Retours

Les sorties de cette opération sont dynamiques.

Supprimer l’utilisateur

ID d’opération :: Users_Remove_V1

Supprimer un utilisateur

Paramètres

Nom	Clé	Obligatoire	Type	Description
Application	application	True	string	ID unique de l’application.
Utilisateur	user_id	True	string	ID unique de l’utilisateur.

Supprimer un appareil

ID d’opération :: Devices_Remove_V1

Supprimez un appareil existant par ID d’appareil.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Application	application	True	string	ID unique de l’application.
ID d’appareil	device_id	True	string	ID unique de l’appareil.

Supprimer un appareil (déconseillé)

ID d’opération :: Devices_Remove

Supprimez un appareil existant par ID d’appareil (déconseillé).

Paramètres

Nom	Clé	Obligatoire	Type	Description
Application	application	True	string	ID unique de l’application.
ID d’appareil	device_id	True	string	ID unique de l’appareil.

Supprimer un groupe d’appareils

ID d’opération :: DeviceGroups_Remove

Supprimer un groupe d’appareils existant par ID

Paramètres

Nom	Clé	Obligatoire	Type	Description
Application	application	True	string	ID unique de l’application.
ID de groupe d’appareils	device_group_id	True	string	ID unique du groupe d’appareils.

Supprimer un modèle d’appareil

ID d’opération :: DeviceTemplates_Remove_V1

Supprimez un modèle d’appareil existant par ID.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Application	application	True	string	ID unique de l’application.
Template	template_id	True	string	ID unique du modèle.

Supprimer un travail planifié

ID d’opération :: ScheduledJobs_Remove

Supprimez un travail planifié existant par ID.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Application	application	True	string	ID unique de l’application.
ID de travail planifié	scheduled_job_id	True	string	ID unique du travail planifié.

Supprimer une organisation

ID d’opération :: Organizations_Remove

Supprimer une organisation existante par ID

Paramètres

Nom	Clé	Obligatoire	Type	Description
Application	application	True	string	ID unique de l’application.
ID d’organisation	organization_id	True	string	ID unique de l’organisation.

Supprimer une relation d’appareil

ID d’opération :: DeviceRelationships_Remove

Supprimez une relation d’appareil existante par ID d’appareil et ID de relation.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Application	application	True	string	ID unique de l’application.
ID d’appareil	device_id	True	string	ID unique de l’appareil.
ID de relation	relationship_id	True	string	ID unique de la relation d’appareil.

Déclencheurs

Lorsqu’une règle est déclenchée

Créez une action qui se déclenche lorsqu’une règle est déclenchée dans IoT Central.

Lorsqu’une règle est déclenchée

ID d’opération :: Workflow_CreateTrigger

Créez une action qui se déclenche lorsqu’une règle est déclenchée dans IoT Central.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Application	application	True	string	ID unique de l’application.
ID de déclencheur de flux de travail	id		string	ID unique du déclencheur de flux de travail.
Règle	rule	True	string	ID unique de la règle liée au déclencheur de flux de travail.

Retours

Les sorties de cette opération sont dynamiques.

Définitions

Device

Nom	Chemin d’accès	Type	Description
ID d’appareil	id	string	ID unique de l’appareil.
Nom de l’appareil	displayName	string	Nom complet de l’appareil.
Modèle d’appareil	instanceOf	string	Définition du modèle d’appareil pour l’appareil.
Simulé	simulated	boolean	Indique si l’appareil est simulé.
Approuvé	approved	boolean	Indique si l’appareil a été approuvé pour se connecter à IoT Central.
approvisionné	provisioned	boolean	Indique si les ressources ont été allouées pour l’appareil.

DeviceV1

Nom	Chemin d’accès	Type	Description
ID d’appareil	id	string	ID unique de l’appareil.
Nom de l’appareil	displayName	string	Nom complet de l’appareil.
Modèle d’appareil	template	string	Définition du modèle d’appareil pour l’appareil.
Simulé	simulated	boolean	Indique si l’appareil est simulé.
Enabled	enabled	boolean	Indique si la connexion de l’appareil à IoT Central a été activée.
approvisionné	provisioned	boolean	Indique si les ressources ont été allouées pour l’appareil.

DeviceV2

Nom	Chemin d’accès	Type	Description
ID d’appareil	id	string	ID unique de l’appareil.
Nom de l’appareil	displayName	string	Nom complet de l’appareil.
Modèle d’appareil	template	string	Définition du modèle d’appareil pour l’appareil.
Simulé	simulated	boolean	Indique si l’appareil est simulé.
Enabled	enabled	boolean	Indique si la connexion de l’appareil à IoT Central a été activée.
Organizations	organizations	array of string	Liste des organisations de l’appareil, une seule organisation est prise en charge aujourd’hui, plusieurs organisations seront bientôt prises en charge.
approvisionné	provisioned	boolean	Indique si les ressources ont été allouées pour l’appareil.

DeviceCollectionV1

Nom	Chemin d’accès	Type	Description
value	value	array of DeviceV1	Collection d’appareils.
nextLink	nextLink	string	URL permettant d’obtenir la page suivante des appareils.

DeviceGroup

Définition du groupe d’appareils.

Nom	Chemin d’accès	Type	Description
ID de groupe d’appareils	id	string	ID unique du groupe d’appareils.
Nom d’affichage	displayName	string	Nom complet du groupe d’appareils.
Filter	filter	string	Interrogez la définition des appareils qui doivent se trouver dans ce groupe.
Descriptif	description	string	Résumé court du groupe d’appareils.
ETag	etag	string	ETag utilisé pour empêcher le conflit dans les mises à jour de groupe d’appareils.
Organizations	organizations	array of string	Liste des organisations du groupe d’appareils, une seule organisation est prise en charge aujourd’hui, plusieurs organisations seront bientôt prises en charge.

DeviceGroupCollection

Résultats paginés des groupes d’appareils.

Nom	Chemin d’accès	Type	Description
ID de groupe d’appareils	value	array of DeviceGroup	Collection de groupes d’appareils.
nextLink	nextLink	string	URL permettant d’obtenir la page suivante des groupes d’appareils.

DeviceGroupDeviceCollection

Résultats paginés des appareils appartenant au groupe d’appareils.

Nom	Chemin d’accès	Type	Description
value	value	array of DeviceV1	Collection d’appareils appartenant au groupe d’appareils.
nextLink	nextLink	string	URL permettant d’obtenir la page suivante des appareils du groupe.

DeviceRelationshipStatic

Nom	Chemin d’accès	Type	Description
ID de relation d’appareil	id	string	ID unique de la relation d’appareil.
ID de source de relation d’appareil	source	string	ID d’appareil de l’appareil source (parent).
ID cible de relation d’appareil	target	string	ID d’appareil de l’appareil source (enfant).

DeviceRelationshipCollection

Nom	Chemin d’accès	Type	Description
value	value	array of DeviceRelationshipStatic	Collection de relations d’appareil.
nextLink	nextLink	string	URL permettant d’obtenir la page suivante des relations d’appareil.

DeviceTemplateV1

Nom	Chemin d’accès	Type	Description
ID de modèle d’appareil	@id	string	ID unique du modèle d’appareil.
Types de modèles d’appareil	@type	array of string	Types JSON-LD de ce modèle d’appareil.
Nom du modèle d’appareil	displayName	string	Nom complet du modèle d’appareil.
Description du modèle d’appareil	description	string	Description détaillée du modèle d’appareil.
Modèle de capacité de modèle d’appareil	capabilityModel		Modèle de capacité utilisé par ce modèle d’appareil.

DeviceTemplateCollectionV1

Nom	Chemin d’accès	Type	Description
value	value	array of DeviceTemplateV1	Collection de modèles d’appareil.
nextLink	nextLink	string	URL permettant d’obtenir la page suivante des modèles d’appareil.

JobDeviceStatus

Définition de l’état de l’appareil de travail.

Nom	Chemin d’accès	Type	Description
ID d’appareil	id	string	ID de l’appareil dont l’état du travail est fourni.
État de l’appareil	status	string	Indique si le travail démarre, s’exécute, etc. pour l’appareil donné.

JobDeviceStatusCollection

Résultats paginés des états de l’appareil de travail.

Nom	Chemin d’accès	Type	Description
value	value	array of JobDeviceStatus	Collection d’états de l’appareil de travail.
nextLink	nextLink	string	URL permettant d’obtenir la page suivante des états de l’appareil de travail.

JobBatch

Définition du lot de travaux.

Nom	Chemin d’accès	Type	Description
Type de lot	type	string	Indique si le traitement par lots est effectué sur un nombre spécifié d’appareils ou un pourcentage du nombre total d’appareils.
Valeur batch	value	number	Nombre ou pourcentage d’appareils sur lesquels le traitement par lots est effectué.

JobCancellationThreshold

Définition du seuil d’annulation du travail.

Nom	Chemin d’accès	Type	Description
Type de seuil d’annulation	type	string	Indique si le seuil d’annulation est défini par un nombre spécifié d’appareils ou un pourcentage du nombre total d’appareils.
Valeur du seuil d’annulation	value	number	Nombre ou pourcentage d’appareils sur lesquels le seuil d’annulation est appliqué.
Lot de seuils d’annulation	batch	boolean	Indique si le seuil d’annulation s’applique par lot ou au travail global.

JobStatic

Définition du travail.

Nom	Chemin d’accès	Type	Description
ID du travail	id	string	ID unique du travail.
Nom d’affichage	displayName	string	Nom complet du travail.
Descriptif	description	string	Description détaillée du travail.
Groupe d’appareils	group	string	ID du groupe d’appareils sur lequel exécuter le travail.
lot	batch	JobBatch	Définition du lot de travaux.
cancellationThreshold	cancellationThreshold	JobCancellationThreshold	Définition du seuil d’annulation du travail.
Data	data	array of object	Données relatives à l’opération effectuée par ce travail. Toutes les entrées doivent être du même type.
items	data	object
Organizations	organizations	array of string	Liste des organisations du travail, une seule organisation est prise en charge aujourd’hui, plusieurs organisations seront bientôt prises en charge.
ID de travail planifié	scheduledJobId	string	ID de la définition de travail planifiée qui a créé ce travail.

JobCollection

Résultats paginés des travaux.

Nom	Chemin d’accès	Type	Description
value	value	array of JobStatic	Collection de travaux.
nextLink	nextLink	string	URL permettant d’obtenir la page suivante des travaux.

Organisation

Nom	Chemin d’accès	Type	Description
ID d’organisation	id	string	ID unique de l’organisation.
Nom de l’organisation	displayName	string	Nom complet de l’organisation.
Parent	parent	string	Nom complet de l’organisation parente.

OrganizationCollection

Nom	Chemin d’accès	Type	Description
value	value	array of Organization	Collection d’organisations.
nextLink	nextLink	string	URL permettant d’obtenir la page suivante des organisations.

RoleV1

Nom	Chemin d’accès	Type	Description
pièce d'identité	id	string	ID unique du rôle.
nom d’affichage	displayName	string	Nom complet du rôle.

RoleCollectionV1

Nom	Chemin d’accès	Type	Description
value	value	array of RoleV1	Collection de rôles.

ScheduledJobStatic

Définition de travail planifiée.

Nom	Chemin d’accès	Type	Description
ETag	etag	string	ETag utilisé pour empêcher les conflits dans les mises à jour de travaux planifiées.
ID de travail planifié	id	string	ID unique du travail planifié.
Nom d’affichage	displayName	string	Nom complet du travail planifié.
Descriptif	description	string	Description détaillée du travail planifié.
Groupe d’appareils	group	string	ID du groupe d’appareils sur lequel exécuter le travail.
lot	batch	JobBatch	Définition du lot de travaux.
cancellationThreshold	cancellationThreshold	JobCancellationThreshold	Définition du seuil d’annulation du travail.
Data	data	array of object	Données relatives à l’opération effectuée par ce travail. Toutes les entrées doivent être du même type.
items	data	object
Organizations	organizations	array of string	Liste des organisations du travail, une seule organisation est prise en charge aujourd’hui, plusieurs organisations seront bientôt prises en charge.
Calendrier	schedule	object	Planification à laquelle exécuter le travail.
Enabled	enabled	boolean	Indique si le travail planifié est activé.
Terminé	completed	boolean	Indique si le travail planifié est terminé.

ScheduledJobJobCollection

Résultats paginés des définitions de travaux appartenant à un travail planifié.

Nom	Chemin d’accès	Type	Description
value	value	array of JobStatic	Collection de travaux.
nextLink	nextLink	string	URL permettant d’obtenir la page suivante des travaux.

UserStaticV1

Nom	Chemin d’accès	Type	Description
ID d’utilisateur	id	string	ID unique de l’utilisateur.
Type d’utilisateur	type	string	Type de l’utilisateur.
Rôles	roles	array of RoleAssignmentV1	Liste des attributions de rôles qui spécifient les autorisations d’accès à l’application.

UserCollectionV1

Nom	Chemin d’accès	Type	Description
Users	value	array of UserStaticV1	Collection d’utilisateurs.

RoleAssignmentV1

Nom	Chemin d’accès	Type	Description
Role	role	string	ID du rôle pour cette attribution de rôle.

Partager via

Azure IoT Central V3 (préversion)

Prerequisites

Comment obtenir des informations d’identification

Notes de publication

Septembre 2021

Novembre 2021

Problèmes connus et limitations

Création d’une connexion

Credentials

Valeur par défaut [DÉCONSEILLÉE]

Limitations

Actions

Arrêter un travail en cours d’exécution

Paramètres

Créer ou mettre à jour un appareil

Paramètres

Retours

Créer ou mettre à jour un appareil (déconseillé)

Paramètres

Retours

Créer ou mettre à jour un appareil (déconseillé)

Paramètres

Retours

Créer un groupe d'appareils

Paramètres

Retours

Créer un travail

Paramètres

Retours

Créer un utilisateur

Paramètres

Retours

Créer une organisation

Paramètres

Retours

Créer une relation d’appareil

Paramètres

Retours

Créer une tâche planifiée

Paramètres

Retours

Exécuter une commande de composant

Paramètres

Retours

Exécuter une commande de composant de module

Paramètres

Retours

Exécuter une commande de module

Paramètres

Retours

Exécuter une commande d’appareil

Paramètres

Retours

Exécuter une commande d’appareil (déconseillée)

Paramètres

Retours

Liste des emplois

Paramètres

Retours

Lister les relations

Paramètres

Retours

Mettre à jour l'utilisateur

Paramètres

Retours

Mettre à jour les propriétés cloud de l’appareil (déconseillées)

Paramètres

Retours

Mettre à jour les propriétés de l’appareil

Paramètres

Retours

Mettre à jour les propriétés de l’appareil (déconseillées)

Paramètres

Retours

Mettre à jour les propriétés de module

Paramètres

Retours

Mettre à jour un travail planifié

Paramètres