Wersje interfejsów API interfejsów API REST płaszczyzny danych usługi Azure IoT Central

Artykuł
05/07/2024

W tym artykule wymieniono bieżące i wcześniejsze wersje interfejsów API REST dla usługi Azure IoT Central.

Stabilne wersje

Te wersje są stabilnymi wersjami, których można użyć do tworzenia rozwiązań produkcyjnych za pomocą usługi Azure IoT Central.

Wersja interfejsu API	Specyfikacja	Aktualizacje interfejsu API
`2022-07-31` (Najnowsze)	Specyfikacja struktury Swagger	Informacje o wersji
`2022-05-31` (Przestarzałe)	Specyfikacja struktury Swagger	Informacje o wersji
`1.0` (Przestarzałe)	Specyfikacja struktury Swagger	Informacje o wersji

Wersje zapoznawcza

Wersje w wersji zapoznawczej są wydawane w celu testowania nowych funkcji, zbierania opinii oraz odnajdywania i rozwiązywania problemów. Interfejsy API w wersji zapoznawczej są dostępne w obszarze Uzupełniające warunki użytkowania i nie są zalecane w przypadku obciążeń produkcyjnych.

Wersja interfejsu API	Specyfikacja	Aktualizacje interfejsu API
`2022-10-31-preview` (Najnowsze)	Specyfikacja struktury Swagger	Informacje o wersji
`2022-06-30-preview` (Przestarzałe)	Specyfikacja struktury Swagger	Informacje o wersji
`1.2-Preview` (Przestarzałe)	Specyfikacja struktury Swagger	Informacje o wersji
`1.1-Preview` (Przestarzałe)	Specyfikacja struktury Swagger	Informacje o wersji

Informacje o wersji

`2022-10-31-preview`

Wersja zapoznawcza interfejsu API płaszczyzny danych REST usługi Azure IoT Central 31 października 2022 r. udostępnia szereg ulepszeń istniejących punktów końcowych i dodaje kilka nowych punktów końcowych w celu włączenia następujących kluczowych funkcji.

Funkcja kwerendy właściwości bieżącego interfejsu API zapytań nie jest już obsługiwana i ogranicza szybkość do jednego żądania na minutę.

Uwaga

Ta funkcja zostanie usunięta do 30 czerwca 2023 r.
Obsługa tworzenia cyklu życia "manifestów wdrażania przeglądarki Microsoft Edge" i zarządzania nim.

Uwaga

Te manifesty zostały teraz oddzielone od szablonów urządzeń i można nimi zarządzać niezależnie.
Usunięcie elementu "deploymentManifest" z definicji "DeviceTemplate". Zgodnie z powyższymi zmianami manifesty wdrożenia są teraz niezależne.

Uwaga

Ta aktualizacja jest zachowaniem zmiany powodującej niezgodność z poprzedniej wersji 2022-06-30-preview.
Obsługa nowego typu "iotEdge" została dodana do jednostki "Device" jako "type: string[]". To pole umożliwia użytkownikowi zidentyfikowanie urządzenia jako urządzenia z włączoną IoT Edge. To pole jest typem opcjonalnym i można kontynuować tworzenie wystąpień urządzeń i zarządzanie nimi bez niego.
```
{

    "type": ["iotEdge"]

}
```
Obsługa nowej applyDeploymentManifest trasy do .Device Ta operacja umożliwia skojarzenie manifestu wdrożenia IoT Edge z wystąpieniem urządzenia.
Obsługa nowego pola readAccess opcjonalnego do FileUpload konfiguracji.
Obsługa w ramach jednostki w idScope celu zapewnienia wygodnego EnrollmentGroup dostępu.
Zaktualizowano obsługę stronicowania przy użyciu nowych parametrów, w tym maxpagesize, filter, orderby. Wcześniej obsługiwane parametry, w tym $filter, $top$orderby zostały wycofane.
Obsługa nowego deviceManifestMigration typu zadania. Ten nowy typ zadania umożliwia zarządzanie flotą urządzeń brzegowych i konfigurowanie deploymentManifest ich dla nich.

`2022-07-31`

Nasza najnowsza wersja ogólnie dostępna 31 lipca 2022 r. poprawia poprzednio istniejącą 2022-05-31 wersję i jest w pełni zgodna z poprzednimi wersjami. Od dzisiaj 2022-05-31 wydanie jest teraz oznaczone jako deprecation i będziemy szukać zakończenia wsparcia dla niego do lipca 2025 roku. Oto zestaw aktualizacji przechwyconych w tej wersji:

Obsługa stanu zadań z stanem postępu
Obsługa zaplanowanych zadań
Obsługa grup rejestracji urządzeń
Obsługa relacji urządzeń
Obsługa listy grup urządzeń

`2022-06-30-preview`

Wersja zapoznawcza interfejsu API płaszczyzny danych REST usługi Azure IoT Central 30 czerwca 2022 r. udostępnia szereg ulepszeń istniejących punktów końcowych i dodaje obsługę następujących kluczowych funkcji:

Obsługa tworzenia dołączania urządzeń i zarządzania nimi Enrollment Groups
Możliwość tworzenia i konfigurowania Scheduled Jobs
Obsługa programowego tworzenia Application Dashboard za pośrednictwem interfejsu API REST
Obsługa niemodelowanych właściwości i poleceń dla polecenia Device
Możliwość wyświetlania listy urządzeń w obrębie Device Group
Podsumowanie postępu pomocy technicznej z zadania
Usunięto pole nazwy z Device Relationship

`2022-05-31`

Najnowsza wersja ogólnie dostępna 31 maja 2022 r. poprawia poprzednio istniejącą 1.0 wersję i jest w pełni zgodna z poprzednimi wersjami. Od dzisiaj 1.0 wydanie jest teraz oznaczone jako deprecation i będziemy szukać zakończenia wsparcia dla niego do maja 2025 roku. Oto zestaw aktualizacji przechwyconych w tej wersji:

Obsługa konfiguracji magazynu przekazywania plików
Obsługa operacji CRUD grupy urządzeń
Obsługa operacji CRUD w organizacji
Obsługa organizacji na urządzeniach, rolach, użytkownikach i tokenach interfejsu API

`1.2-Preview (Deprecated)`

Wydanie 1.2-preview stale ulepsza nasze punkty końcowe interfejsu API z poprzednich wersji zapoznawczych i dodaje obsługę następujących funkcji:

Obsługa operacji CRUD grupy urządzeń
Nowy typ zadania do obsługi migracji szablonu urządzenia

`1.0`

Pierwsza wersja interfejsu API REST ogólnie dostępnego dla usługi Azure IoT Central, która przechwytuje obsługę następujących punktów końcowych: Urządzenia, Lista ról, Użytkownicy, Szablony urządzeń i Tokeny interfejsu API. Więcej informacji na temat poszczególnych punktów końcowych można znaleźć tutaj.

Użytkownicy bez pomocy technicznej organizacji.
Lista ról bez obsługi organizacji.
Urządzenia CRUD, właściwości, polecenia, poświadczenia, obsługa zaświadczania.
Tokeny interfejsu API bez obsługi organizacji.
Szablon urządzenia bez obsługi poprawki PATCH.

`1.1-Preview (Deprecated)`

Ta wersja umożliwia obsługę języka DTDL w wersji 2 na powierzchni interfejsu API REST dla usługi Azure IoT Central. Obejmuje to zmiany powodujące niezgodność ze starszej preview wersji (teraz przestarzałe).

DTDLv2 wyrównanie, przeczytaj więcej szczegółów.
Obsługa relacji urządzenia.
Obsługa konfiguracji FileUpload.
Obsługa organizacji.
Obsługa zapytań telemetrycznych urządzenia.
Obsługa zadań.
Usunięto starszą obsługę ciągłego eksportu danych.
Dodano obsługę eksportu danych w wersji 2 eksportu/miejsca docelowego.
Usunięto interfejs API/urządzenia/{deviceId}/cloudProperties przy użyciu interfejsu API/urządzeń/{deviceId}/properties.
Właściwości urządzenia i telemetrie w ramach dziedziczonego interfejsu nie będą traktowane jako właściwość główna i telemetria katalogu głównego.
Obsługa poprawek szablonu urządzenia.
Obsługa manifestu przeglądarki Edge na podstawie szablonu urządzenia.

`Preview (Deprecated & Removed)`

Pierwsza wersja publicznego interfejsu API usługi Azure IoT Central z obsługą DTDL v1 tylko została wycofana i usunięta z naszych punktów końcowych interfejsu API REST.

Udostępnij za pośrednictwem