API-versioner av REST-API:er för Azure IoT Central-dataplanet

Artikel
05/07/2024

I den här artikeln visas de aktuella och tidigare versionerna av REST-API:erna för Azure IoT Central.

Stabila versioner

Dessa versioner är stabila versioner som kan användas för att utveckla produktionslösningar med Azure IoT Central.

API-version	Specifikation	API-uppdateringar
`2022-07-31` (Senaste)	Swagger-specifikation	Versionsanteckning
`2022-05-31` (Inaktuell)	Swagger-specifikation	Versionsanteckning
`1.0` (Inaktuell)	Swagger-specifikation	Versionsanteckning

Förhandsversioner

Förhandsversioner släpps för att testa nya funktioner, samla in feedback och identifiera och åtgärda problem. Förhandsversions-API:er är tillgängliga under kompletterande användningsvillkor och rekommenderas inte för produktionsarbetsbelastningar.

API-version	Specifikation	API-uppdateringar
`2022-10-31-preview` (Senaste)	Swagger-specifikation	Versionsanteckning
`2022-06-30-preview` (Inaktuell)	Swagger-specifikation	Versionsanteckning
`1.2-Preview` (Inaktuell)	Swagger-specifikation	Versionsanteckning
`1.1-Preview` (Inaktuell)	Swagger-specifikation	Versionsanteckning

Viktig information

`2022-10-31-preview`

Förhandsversionen av AZURE IoT Central REST Data Plane API den 31 oktober 2022 ger en serie förbättringar av befintliga slutpunkter och lägger till flera nya slutpunkter för att aktivera följande viktiga funktioner.

Egenskapsfrågefunktionen i det aktuella fråge-API:et stöds inte längre och har begränsat hastigheten till en begäran per minut.

Anteckning

Den här funktionen tas bort senast den 30 juni 2023.
Stöd för att skapa och hantera livscykeln för Distributionsmanifest för Microsoft Edge.

Anteckning

Dessa manifest har nu frikopplats från enhetsmallarna och kan hanteras oberoende av varandra.
Borttagning av "deploymentManifest" från "DeviceTemplate"-definitionen. Enligt ovanstående ändring är distributionsmanifesten nu oberoende.

Anteckning

Den här uppdateringen är ett icke-bakåtkompatibelt ändringsbeteende från den tidigare förhandsversionen 2022-06-30.
Stöd för en ny "iotEdge"-typ har lagts till i enhetsentiteten som en "typ: sträng[]". Med det här fältet kan användaren identifiera en enhet som en IoT Edge aktiverad enhet. Det här fältet är en valfri typ och du kan fortsätta att skapa och hantera enhetsinstanser utan det.
```
{

    "type": ["iotEdge"]

}
```
Stöd för en ny applyDeploymentManifest väg till Device. Med den här åtgärden kan du associera ett IoT Edge distributionsmanifest till en enhetsinstans.
Stöd för nytt valfritt fält readAccess för FileUpload konfiguration.
Stöd för idScope inom entiteten EnrollmentGroup för bekväm åtkomst.
Stöd för sidindelning med nya parametrar har uppdaterats, inklusive maxpagesize, filter, orderby. Och de parametrar som tidigare stöds, inklusive $filter, $top, $orderby har nu dragits tillbaka.
Stöd för ny deviceManifestMigration jobbtyp. Med den här nya jobbtypen kan du hantera din flotta av Edge-enheter och konfigurera en deploymentManifest för dem.

`2022-07-31`

Vår senaste GA-version den 31 juli 2022 förbättrar den tidigare befintliga 2022-05-31 versionen och är helt bakåtkompatibel. Från och med idag 2022-05-31 är versionen nu markerad för deprecation och vi kommer att försöka avsluta supporten för den i juli 2025. Här är en uppsättning uppdateringar som hämtas i den här versionen:

Jobb med statusstöd för förlopp
Stöd för schemalagda jobb
Stöd för enhetsregistreringsgrupper
Stöd för enhetsrelationer
Stöd för enhetsgrupper lista enheter

`2022-06-30-preview`

Förhandsversionen av Azure IoT Central REST Data Plane API den 30 juni 2022 ger en serie förbättringar av befintliga slutpunkter och lägger till stöd för följande viktiga funktioner:

Stöd för att skapa och hantera Enrollment Groups för enhetsregistrering
Möjlighet att skapa och konfigurera Scheduled Jobs
Stöd för programmatiskt skapande Application Dashboard via REST API
Stöd för odefinierade egenskaper och kommandon för Device
Möjlighet att lista enheter i en Device Group
Sammanfattning av supportförlopp från jobb
Namnfältet har tagits bort från Device Relationship

`2022-05-31`

Vår senaste GA-version den 31 maj 2022 förbättrar den tidigare versionen 1.0 och är helt bakåtkompatibel. Från och med idag 1.0 är versionen nu markerad för deprecation och vi kommer att se till att avsluta stödet för den i maj 2025. Här är en uppsättning uppdateringar som hämtas i den här versionen:

Konfigurationsstöd för filuppladdning av lagring
CRUD-stöd för enhetsgrupp
Crud-stöd för organisation
Organisationsstöd för enheter, roller, användare och API-token

`1.2-Preview (Deprecated)`

Versionen 1.2-preview förbättrar kontinuerligt våra API-slutpunkter från tidigare förhandsversioner och lägger till stöd för följande funktioner:

CRUD-stöd för enhetsgrupp
Ny jobbtyp som stöd för migrering av enhetsmallar

`1.0`

Den första GA REST API-versionen för Azure IoT Central som samlar in stöd för följande slutpunkter: Enheter, rolllista, användare, enhetsmallar och API-token. Du kan läsa mer om var och en av slutpunkterna här.

Användare utan organisationsstöd.
Rolllista utan organisationsstöd.
ENHETER CRUD, egenskaper, kommandon, autentiseringsuppgifter, attesteringsstöd.
API-token utan organisationsstöd.
Enhetsmall utan PATCH-stöd.

`1.1-Preview (Deprecated)`

Den här versionen aktiverar stöd för DTDL v2 på REST API-ytan för Azure IoT Central. Den innehåller icke-bakåtkompatibla ändringar från äldre preview version (nu inaktuell).

DTDLv2 justering, läs mer information.
Stöd för enhetsrelation.
Stöd för FileUpload-konfiguration.
Organisationsstöd.
Stöd för enhetstelemetrifråga.
Jobbstöd.
Äldre stöd för kontinuerlig dataexport har tagits bort.
Lägg till stöd för Data Export V2 Export/Destination.
Api/devices/{deviceId}/cloudProperties har tagits bort med hjälp av api/devices/{deviceId}/properties.
Enhetsegenskaper och telemetrier under ärvt gränssnitt behandlas inte som rotegenskap och rottelemetri.
Stöd för uppdatering av enhetsmallar.
Stöd för Edge-manifest från enhetsmall.

`Preview (Deprecated & Removed)`

Den första versionen av det offentliga API:et för Azure IoT Central, med endast stöd för DTDL v1 , har nu blivit inaktuell och tagits bort från våra REST API-slutpunkter.

Dela via