Az Azure IoT Central Data Plane REST API-k API-verziói
Ez a cikk az Azure IoT Central REST API-jainak aktuális és korábbi verzióit sorolja fel.
Stabil verziók
Ezek a verziók azok a stabil kiadások, amelyek felhasználhatók éles megoldások fejlesztésére az Azure IoT Centrallal.
API-verzió | Specifikáció | API-frissítések |
---|---|---|
2022-07-31 (Legújabb) |
Swagger-specifikáció | Kibocsátási megjegyzés |
2022-05-31 (Elavult) |
Swagger-specifikáció | Kibocsátási megjegyzés |
1.0 (Elavult) |
Swagger-specifikáció | Kibocsátási megjegyzés |
Előzetes verzió
Az előzetes verziókkal tesztelheti az új funkciókat, visszajelzéseket gyűjthet, és felderítheti és kijavíthatja a problémákat. Az előzetes verziójú API-k a kiegészítő használati feltételek alatt érhetők el, és éles számítási feladatokhoz nem ajánlottak.
API-verzió | Specifikáció | API-frissítések |
---|---|---|
2022-10-31-preview (Legújabb) |
Swagger-specifikáció | Kibocsátási megjegyzés |
2022-06-30-preview (Elavult) |
Swagger-specifikáció | Kibocsátási megjegyzés |
1.2-Preview (Elavult) |
Swagger-specifikáció | Kibocsátási megjegyzés |
1.1-Preview (Elavult) |
Swagger-specifikáció | Kibocsátási megjegyzés |
Kibocsátási megjegyzések
2022-10-31-preview
Az Azure IoT Central REST Data Plane API 2022. október 31-i előzetes kiadása számos fejlesztést biztosít a meglévő végpontokhoz, és számos új végpontot ad hozzá az alábbi fő képességek engedélyezéséhez.
Az aktuális Query API tulajdonság lekérdezési funkciója már nem támogatott, és percenként egy kérésre korlátozta a sebességet.
Megjegyzés
Ezt a funkciót 2023. június 30-ig eltávolítjuk.
Támogatás a "Microsoft Edge üzembehelyezési jegyzékek" életciklusának létrehozásához és kezeléséhez.
Megjegyzés
Ezek a jegyzékfájlok mostantól leválasztva lettek az eszközsablonokról, és egymástól függetlenül kezelhetők.
A "deploymentManifest" eltávolítása a DeviceTemplate definícióból. A fenti módosítás alapján az üzembehelyezési jegyzékek mostantól függetlenek.
Megjegyzés
Ez a frissítés a korábbi, 2022.06.30-i előzetes kiadás kompatibilitástörő változási viselkedése.
Az "iotEdge" új típusának támogatása "típus: sztring[]" néven lett hozzáadva az "Eszköz" entitáshoz. Ez a mező lehetővé teszi, hogy a felhasználó IoT Edge engedélyezett eszközként azonosítsa az eszközt. Ez a mező választható típus, és anélkül is létrehozhat és kezelhet eszközpéldányokat.
{ "type": ["iotEdge"] }
applyDeploymentManifest
Új útvonal támogatása a következőhözDevice
: . Ezzel a művelettel IoT Edge üzembehelyezési jegyzékfájlt társíthat egy eszközpéldányhoz.Új nem kötelezően konfigurálható
FileUpload
mezőreadAccess
támogatása.idScope
Az entitáson belüliEnrollmentGroup
támogatás a kényelmes hozzáférés érdekében.Frissítettük a lapozás támogatását új paraméterekkel, például
maxpagesize
,filter
,orderby
. A korábban támogatott paraméterek ( például$filter
,$top
)$orderby
pedig ki lettek vonva.Új
deviceManifestMigration
feladattípus támogatása. Ez az új feladattípus lehetővé teszi az Edge-eszközök flottájának kezelését és konfigurálásátdeploymentManifest
.
2022-07-31
A legújabb ga kiadásunk 2022. július 31-én javítja a korábban meglévő 2022-05-31
kiadást, és teljes mértékben visszamenőlegesen kompatibilis. A mai napig a 2022-05-31
kiadás már meg van jelölve deprecation
, és 2025 júliusáig meg fogjuk szűnni a támogatását. Az alábbiakban az ebben a kiadásban rögzített frissítéseket találja:
- Állapottámogatással rendelkező feladatok
- Ütemezett feladatok támogatása
- Eszközregisztrációs csoportok támogatása
- Eszközkapcsolatok támogatása
- Eszközcsoportok listázása – Eszközök támogatása
2022-06-30-preview
Az Azure IoT Central REST Data Plane API 2022. június 30-i előzetes kiadása számos fejlesztést biztosít a meglévő végpontokhoz, és támogatja a következő fő képességeket:
- Eszközök előkészítésének és kezelésének
Enrollment Groups
támogatása - Létrehozási és konfigurálási képesség
Scheduled Jobs
- Rest API-val történő programozott létrehozás
Application Dashboard
támogatása - A nem átalakított tulajdonságok és parancsok támogatása a következőhöz:
Device
- Eszközök listázása egy adott eszközön belül
Device Group
- Támogatási folyamat összegzése a feladatból
- A névmező el lett távolítva a
Device Relationship
2022-05-31
A legújabb ga kiadásunk 2022. május 31-én javítja a korábban meglévő 1.0
kiadást, és teljes mértékben visszamenőlegesen kompatibilis. A mai napig a 1.0
kiadás már meg van jelölve deprecation
, és 2025 májusáig meg fogjuk szűnni a támogatását. Az alábbiakban az ebben a kiadásban rögzített frissítéseket találja:
- Fájlfeltöltési tár konfigurációjának támogatása
- Eszközcsoport CRUD-támogatása
- Szervezeti CRUD-támogatás
- Szervezeti támogatás eszközökhöz, szerepkörökhöz, felhasználókhoz és API-jogkivonatokhoz
1.2-Preview (Deprecated)
A 1.2-preview
kiadás folyamatosan javítja az API-végpontokat a korábbi előzetes kiadásokhoz képest, és támogatja a következő funkciókat:
- Eszközcsoport CRUD-támogatása
- Új feladattípus az eszközsablonok áttelepítésének támogatásához
1.0
Az Azure IoT Central első GA REST API-kiadása, amely a következő végpontok támogatását rögzíti: Eszközök, Szerepkörök listája, Felhasználók, Eszközsablonok és API-tokenek. Az egyes végpontokról itt tudhat meg többet.
- Szervezeti támogatással nem rendelkező felhasználók.
- Szerepkörök listája szervezeti támogatás nélkül.
- Eszközök CRUD, tulajdonságok, parancsok, hitelesítő adatok, igazolások támogatása.
- API-jogkivonatok szervezeti támogatás nélkül.
- Eszközsablon PATCH-támogatás nélkül.
1.1-Preview (Deprecated)
Ez a kiadás lehetővé teszi a DTDL v2 támogatását az Azure IoT Central REST API-felületén. Ez magában foglalja az örökölt preview
verzió kompatibilitástörő változásait (most már elavult).
-
DTDLv2
igazítás, további részletek. - Eszközkapcsolatok támogatása.
- A FileUpload konfigurációs támogatása.
- Szervezeti támogatás.
- Eszköz telemetriai lekérdezésének támogatása.
- Feladatok támogatása.
- Az örökölt folyamatos adatexportálási támogatás el lett távolítva.
- Adatexportálási V2 exportálási/céltámogatás hozzáadása.
- Api/devices/{deviceId}/cloudProperties eltávolítása api/devices/{deviceId}/properties használatával.
- Az örökölt felületen lévő eszköztulajdonságok és telemetriák nem lesznek gyökértulajdonságként és gyökértelemetriaként kezelve.
- Az eszközsablonok javítási támogatása.
- Edge-jegyzéktámogatás eszközsablonból.
Preview (Deprecated & Removed)
Az Azure IoT Central nyilvános API első, csak támogatott DTDL v1
verziója elavult, és el lett távolítva a REST API-végpontokból.