API-versies van Azure IoT Central Data Plane REST API's

Artikel
05/07/2024

In dit artikel worden de huidige en eerdere versies van de REST API's voor Azure IoT Central vermeld.

Stabiele versies

Deze versies zijn de stabiele releases die kunnen worden gebruikt voor het ontwikkelen van productieoplossingen met Azure IoT Central.

API-versie	Specificatie	API-updates
`2022-07-31` (Meest recente)	Swagger-specificatie	Releaseopmerking
`2022-05-31` (Afgeschaft)	Swagger-specificatie	Releaseopmerking
`1.0` (Afgeschaft)	Swagger-specificatie	Releaseopmerking

Preview-versies

Preview-versies worden uitgebracht om nieuwe functionaliteit te testen, feedback te verzamelen en problemen op te sporen en op te lossen. Preview-API's zijn beschikbaar onder Aanvullende gebruiksvoorwaarden en worden niet aanbevolen voor productieworkloads.

API-versie	Specificatie	API-updates
`2022-10-31-preview` (Meest recente)	Swagger-specificatie	Releaseopmerking
`2022-06-30-preview` (Afgeschaft)	Swagger-specificatie	Releaseopmerking
`1.2-Preview` (Afgeschaft)	Swagger-specificatie	Releaseopmerking
`1.1-Preview` (Afgeschaft)	Swagger-specificatie	Releaseopmerking

Opmerkingen bij de release

`2022-10-31-preview`

De preview-versie van Azure IoT Central REST Data Plane API op 31 oktober 2022 biedt een reeks verbeteringen aan bestaande eindpunten en voegt verschillende nieuwe eindpunten toe om de volgende belangrijke mogelijkheden mogelijk te maken.

De eigenschapsqueryfunctie van de huidige Query-API wordt niet meer ondersteund en heeft de snelheid beperkt tot één aanvraag per minuut.

Notitie

Deze functie wordt op 30 juni 2023 verwijderd.
Ondersteuning voor het maken en beheren van de levenscyclus voor 'Microsoft Edge-implementatiemanifesten'.

Notitie

Deze manifesten zijn nu losgekoppeld van de apparaatsjablonen en kunnen onafhankelijk worden beheerd.
Verwijdering van 'deploymentManifest' uit de definitie van 'DeviceTemplate'. Volgens de bovenstaande wijziging zijn implementatiemanifesten nu onafhankelijk.

Notitie

Deze update is een wijziging die fouten veroorzaakt ten aanzien van de vorige versie van 2022-06-30-preview.
Ondersteuning voor een nieuw type 'iotEdge' is toegevoegd aan de entiteit 'Device' als een 'type: string[]'. Met dit veld kan de gebruiker een apparaat identificeren als een apparaat met IoT Edge ingeschakeld. Dit veld is een optioneel type en u kunt zonder dit veld apparaatexemplaren blijven maken en beheren.
```
{

    "type": ["iotEdge"]

}
```
Ondersteuning voor een nieuwe applyDeploymentManifest route naar Device. Met deze bewerking kunt u een IoT Edge-implementatiemanifest koppelen aan een apparaatexemplementatie.
Ondersteuning voor nieuw optioneel veld readAccess voor FileUpload configuratie.
Ondersteuning voor idScope binnen de EnrollmentGroup entiteit voor handige toegang.
Ondersteuning voor paging bijgewerkt met nieuwe parameters, waaronder maxpagesize, filter, orderby. En de eerder ondersteunde parameters, waaronder $filter, $top, $orderby zijn nu buiten gebruik gesteld.
Ondersteuning voor nieuw deviceManifestMigration taaktype. Met dit nieuwe taaktype kunt u uw vloot edge-apparaten beheren en een deploymentManifest voor deze apparaten configureren.

`2022-07-31`

Onze nieuwste GA-release op 31 juli 2022 verbetert de eerder bestaande 2022-05-31 release en is volledig achterwaarts compatibel. Vanaf vandaag is de 2022-05-31 release gemarkeerd voor deprecation en we kijken ernaar om de ondersteuning ervoor te beëindigen tegen juli 2025. Hier ziet u een reeks updates die in deze release zijn vastgelegd:

Taken met ondersteuning voor voortgangsstatus
Ondersteuning voor geplande taken
Ondersteuning voor apparaatinschrijvingsgroepen
Ondersteuning voor apparaatrelaties
Ondersteuning voor lijst met apparaatgroepen Apparaten

`2022-06-30-preview`

De preview-versie van Azure IoT Central REST Data Plane API op 30 juni 2022 biedt een reeks verbeteringen aan bestaande eindpunten en voegt ondersteuning toe voor de volgende belangrijke mogelijkheden:

Ondersteuning voor het maken en beheren van Enrollment Groups onboarding van apparaten
Mogelijkheid om te maken en configureren Scheduled Jobs
Ondersteuning voor programmatisch maken Application Dashboard via REST API
Ondersteuning voor niet-gemodelleerde eigenschappen en opdrachten voor Device
Mogelijkheid om apparaten weer te geven binnen een Device Group
Overzicht van ondersteuningsvoortgang van taak
Naamveld verwijderd uit Device Relationship

`2022-05-31`

Onze nieuwste GA-release op 31 mei 2022 verbetert de eerder bestaande 1.0 release en is volledig achterwaarts compatibel. Vanaf vandaag is de 1.0 release gemarkeerd voor deprecation en we kijken ernaar om de ondersteuning voor de release tegen mei 2025 te beëindigen. Hier ziet u een reeks updates die in deze release zijn vastgelegd:

Ondersteuning voor opslagconfiguratie voor het uploaden van bestanden
CRUD-ondersteuning voor apparaatgroepen
CruD-ondersteuning voor organisaties
Organisatieondersteuning op apparaten, rollen, gebruikers en API-tokens

`1.2-Preview (Deprecated)`

De 1.2-preview release verbetert voortdurend onze API-eindpunten van eerdere preview-releases en voegt ondersteuning toe voor de volgende functies:

CRUD-ondersteuning voor apparaatgroepen
Nieuw taaktype ter ondersteuning van migratie van apparaatsjablonen

`1.0`

Eerste GA REST API-release voor Azure IoT Central die ondersteuning voor de volgende eindpunten vastlegt: Apparaten, Rollenlijst, Gebruikers, Apparaatsjablonen en API-tokens. Meer informatie over elk van de eindpunten vindt u hier.

Gebruikers zonder ondersteuning van de organisatie.
Lijst met rollen zonder ondersteuning van de organisatie.
Apparaten CRUD, eigenschappen, opdrachten, referenties, attestation-ondersteuning.
API-tokens zonder ondersteuning van de organisatie.
Apparaatsjabloon zonder PATCH-ondersteuning.

`1.1-Preview (Deprecated)`

Deze release biedt ondersteuning voor DTDL v2 binnen de REST API-surface voor Azure IoT Central. Het bevat wijzigingen die fouten veroorzaken ten laste van de verouderde preview versie (nu afgeschaft).

DTDLv2 uitlijning, lees meer details.
Ondersteuning voor apparaatrelaties.
Ondersteuning voor FileUpload-configuratie.
Ondersteuning van de organisatie.
Ondersteuning voor apparaattelemetriequery's.
Ondersteuning voor taken.
Verouderde ondersteuning voor continue gegevensexport is verwijderd.
Ondersteuning voor gegevensexport V2-export/doel toevoegen.
Api/devices/{deviceId}/cloudProperties is verwijderd met api/devices/{deviceId}/properties.
Apparaateigenschappen en telemetrieën onder overgenomen interface worden niet behandeld als hoofdeigenschap en hoofdtelemetrie.
Ondersteuning voor patching van apparaatsjablonen.
Edge-manifestondersteuning van apparaatsjabloon.

`Preview (Deprecated & Removed)`

De eerste versie van de openbare API van Azure IoT Central, met alleen ondersteuning voor DTDL v1 , is nu afgeschaft en verwijderd uit onze REST API-eindpunten.

Delen via