Versions d’API des API REST du plan de données Azure IoT Central

Article
07/19/2023

Cet article répertorie les versions actuelles et passées des API REST pour Azure IoT Central.

Versions stables

Ces versions sont les versions stables qui peuvent être utilisées pour développer des solutions de production avec Azure IoT Central.

Version de l'API	Caractéristique	Mises à jour des API
`2022-07-31` (Dernière version)	Spécification Swagger	Note de publication
`2022-05-31` (Déconseillé)	Spécification Swagger	Note de publication
`1.0` (Déconseillé)	Spécification Swagger	Note de publication

Préversions

Les versions préliminaires sont publiées pour tester les nouvelles fonctionnalités, recueillir des commentaires et détecter et résoudre les problèmes. Les API en préversion sont disponibles sous Conditions d’utilisation supplémentaires et ne sont pas recommandées pour les charges de travail de production.

Version de l'API	Caractéristique	Mises à jour des API
`2022-10-31-preview` (Dernière version)	Spécification Swagger	Note de publication
`2022-06-30-preview` (Déconseillé)	Spécification Swagger	Note de publication
`1.2-Preview` (Déconseillé)	Spécification Swagger	Note de publication
`1.1-Preview` (Déconseillé)	Spécification Swagger	Note de publication

Notes de publication

`2022-10-31-preview`

La préversion de l’API de plan de données REST Azure IoT Central le 31 octobre 2022 apporte une série d’améliorations aux points de terminaison existants et ajoute plusieurs nouveaux points de terminaison pour activer les fonctionnalités clés suivantes.

La fonctionnalité de requête de propriété de l’API de requête actuelle n’est plus prise en charge et a limité le taux à une requête par minute.

Notes

Cette fonctionnalité sera supprimée d’ici le 30 juin 2023.
Prise en charge de la création et de la gestion du cycle de vie des « manifestes de déploiement Microsoft Edge ».

Notes

Ces manifestes ont maintenant été dissociés des modèles d’appareil et peuvent être gérés indépendamment.
Suppression de « deploymentManifest » de la définition « DeviceTemplate ». En fonction de la modification ci-dessus, les manifestes de déploiement sont désormais indépendants.

Notes

Cette mise à jour est un changement de comportement cassant par rapport à la version précédente 2022-06-30-preview.
La prise en charge d’un nouveau type « iotEdge » a été ajoutée à l’entité « Device » en tant que « type : string[] ». Ce champ permet à l’utilisateur d’identifier un appareil en tant qu’appareil IoT Edge activé. Ce champ est un type facultatif et vous pouvez continuer à créer et à gérer des instances d’appareil sans lui.
```
{

    "type": ["iotEdge"]

}
```
Prise en charge d’une nouvelle applyDeploymentManifest route vers Device. Cette opération vous permet d’associer un manifeste de déploiement IoT Edge à une instance d’appareil.
Prise en charge du nouveau champ readAccess facultatif à la FileUpload configuration.
Prise en charge au idScope sein de l’entité EnrollmentGroup pour un accès pratique.
Mise à jour de la prise en charge de la pagination avec de nouveaux paramètres, notamment maxpagesize, filter, orderby. Et les paramètres précédemment pris en charge, y compris $filter, $top, $orderby ont été mis hors service.
Prise en charge du nouveau deviceManifestMigration type de travail. Ce nouveau type de travail vous permet de gérer votre flotte d’appareils Edge et de configurer un deploymentManifest pour eux.

`2022-07-31`

Notre dernière version en disponibilité générale du 31 juillet 2022 améliore la version existante 2022-05-31 et est entièrement rétrocompatible. À partir d’aujourd’hui, la 2022-05-31 version est désormais marquée pour deprecation et nous allons envisager de mettre fin à son support d’ici juillet 2025. Voici un ensemble de mises à jour capturées dans cette version :

Travaux avec prise en charge de l’état de progression
Prise en charge des travaux planifiés
Prise en charge des groupes d’inscription d’appareils
Prise en charge des relations d’appareil
Prise en charge de la liste des groupes d’appareils

`2022-06-30-preview`

La préversion de l’API de plan de données REST Azure IoT Central le 30 juin 2022 apporte une série d’améliorations aux points de terminaison existants et ajoute la prise en charge des fonctionnalités clés suivantes :

Prise en charge de la création et de la gestion Enrollment Groups pour l’intégration des appareils
Possibilité de créer et de configurer Scheduled Jobs
Prise en charge de la création Application Dashboard par programmation via l’API REST
Prise en charge des propriétés et commandes non modélisées pour Device
Possibilité de lister des appareils dans un Device Group
Récapitulatif de la progression de la prise en charge à partir du travail
Champ de nom supprimé de Device Relationship

`2022-05-31`

Notre dernière version en disponibilité générale du 31 mai 2022 améliore la version existante 1.0 et est entièrement rétrocompatible. À partir d’aujourd’hui, la 1.0 version est désormais marquée pour deprecation et nous allons envisager de mettre fin à son support d’ici mai 2025. Voici un ensemble de mises à jour capturées dans cette version :

Prise en charge de la configuration du stockage de chargement de fichiers
Prise en charge crud du groupe d’appareils
Prise en charge crud de l’organisation
Prise en charge de l’organisation sur les appareils, les rôles, les utilisateurs et les jetons d’API

`1.2-Preview (Deprecated)`

La 1.2-preview version améliore continuellement nos points de terminaison d’API par rapport aux versions préliminaires précédentes et ajoute la prise en charge des fonctionnalités suivantes :

Prise en charge crud du groupe d’appareils
Nouveau type de travail pour prendre en charge la migration de modèle d’appareil

`1.0`

Première version de l’API REST ga pour Azure IoT Central qui capture la prise en charge des points de terminaison suivants : Appareils, Liste de rôles, Utilisateurs, Modèles d’appareil et Jetons d’API. Vous pouvez en savoir plus sur chacun des points de terminaison ici.

Utilisateurs sans support de l’organisation.
Liste des rôles sans prise en charge de l’organisation.
Crud des appareils, propriétés, commandes, informations d’identification, prise en charge de l’attestation.
Jetons d’API sans prise en charge de l’organisation.
Modèle d’appareil sans prise en charge de PATCH.

`1.1-Preview (Deprecated)`

Cette version active la prise en charge de DTDL v2 dans la surface de l’API REST pour Azure IoT Central. Il inclut les modifications cassants de la version héritée preview (désormais déconseillée).

DTDLv2 alignement, lisez plus d’informations.
Prise en charge des relations d’appareil.
Prise en charge de la configuration FileUpload.
Support de l’organisation.
Prise en charge des requêtes de télémétrie d’appareil.
Prise en charge des travaux.
Suppression de la prise en charge de l’exportation continue de données héritée.
Ajoutez la prise en charge de l’exportation/destination des données v2.
Suppression de api/devices/{deviceId}/cloudProperties, à l’aide de api/devices/{deviceId}/properties.
Les propriétés de l’appareil et les télémétries sous l’interface héritée ne sont pas traitées comme des données de télémétrie de propriété racine et de propriété racine.
Prise en charge de la mise à jour corrective des modèles d’appareil.
Prise en charge du manifeste Edge à partir du modèle d’appareil.

`Preview (Deprecated & Removed)`

La première version de l’API publique Azure IoT Central, avec prise en charge DTDL v1 uniquement, a été dépréciée et supprimée de nos points de terminaison d’API REST.