Verze rozhraní API rozhraní REST API roviny dat Azure IoT Central

Tento článek obsahuje seznam aktuálních a minulých verzí rozhraní REST API pro Azure IoT Central.

Stabilní verze

Tyto verze jsou stabilními verzemi, které je možné použít k vývoji produkčních řešení pomocí Azure IoT Central.

Verze rozhraní API Specifikace Aktualizace rozhraní API
2022-07-31 (Nejnovější) Specifikace Swaggeru Poznámka k verzi
2022-05-31 (Zastaralé) Specifikace Swaggeru Poznámka k verzi
1.0 (Zastaralé) Specifikace Swaggeru Poznámka k verzi

Verze Preview

Verze Preview se vydávají za účelem testování nových funkcí, získávání zpětné vazby a zjišťování a oprav problémů. Rozhraní API verze Preview jsou k dispozici v dodatečných podmínkách použití a nedoporučují se pro úlohy v produkčním prostředí.

Verze rozhraní API Specifikace Aktualizace rozhraní API
2022-10-31-preview (Nejnovější) Specifikace Swaggeru Poznámka k verzi
2022-06-30-preview (Zastaralé) Specifikace Swaggeru Poznámka k verzi
1.2-Preview (Zastaralé) Specifikace Swaggeru Poznámka k verzi
1.1-Preview (Zastaralé) Specifikace Swaggeru Poznámka k verzi

Poznámky k verzi

2022-10-31-preview

Verze Preview rozhraní API roviny dat Azure IoT Central z 31. října 2022 přináší řadu vylepšení stávajících koncových bodů a přidává několik nových koncových bodů, které umožňují následující klíčové funkce.

  • Funkce dotazu na vlastnosti aktuálního rozhraní API pro dotazy se už nepodporuje a omezuje rychlost na jeden požadavek za minutu.

    Poznámka

    Tato funkce bude odebrána do 30. června 2023.

  • Podpora vytváření a správy životního cyklu pro manifesty nasazení Microsoft Edge.

    Poznámka

    Tyto manifesty jsou teď oddělené od šablon zařízení a dají se spravovat nezávisle.

  • Odebrání deploymentManifest z definice DeviceTemplate. V rámci výše uvedené změny jsou teď manifesty nasazení nezávislé.

    Poznámka

    Tato aktualizace představuje zásadní změnu chování z předchozí verze 2022-06-30-preview.

  • Podpora nového typu iotEdge byla přidána do entity Device jako typ: string[]. Toto pole umožňuje uživateli identifikovat zařízení jako zařízení s povolenou IoT Edge. Toto pole je volitelný typ a bez něj můžete pokračovat ve vytváření a správě instancí zařízení.

    
    {
    
        "type": ["iotEdge"]
    
    }
    
    
  • Podpora nové applyDeploymentManifest trasy do Device. Tato operace umožňuje přidružit manifest nasazení IoT Edge k instanci zařízení.

  • Podpora nového volitelného pole readAccess pro FileUpload konfiguraci.

  • Podpora pro idScope v rámci EnrollmentGroup entity pro pohodlný přístup

  • Aktualizace podpory stránkování s novými parametry, jako jsou maxpagesize, filter, . orderby Dříve podporované parametry, včetně $filter, $top$orderby byly nyní vyřazeny.

  • Podpora pro nový deviceManifestMigration typ úlohy Tento nový typ úlohy umožňuje spravovat vozový park hraničních zařízení a nakonfigurovat pro ně zařízení deploymentManifest .

2022-07-31

Naše nejnovější verze GA z 31. července 2022 vylepšuje dříve existující 2022-05-31 verzi a je plně zpětně kompatibilní. K dnešnímu 2022-05-31 dne je tato verze označená jako deprecation a do července 2025 pro ni budeme chtít ukončit podporu. Tady je sada aktualizací zachycených v této verzi:

  • Úlohy s podporou stavu průběhu
  • Podpora naplánovaných úloh
  • Podpora skupin registrace zařízení
  • Podpora relací zařízení
  • Skupiny zařízení – Seznam podpory zařízení

2022-06-30-preview

Verze Preview rozhraní API roviny dat Azure IoT Central z 30. června 2022 přináší řadu vylepšení stávajících koncových bodů a přidává podporu následujících klíčových funkcí:

  • Podpora vytváření a správy Enrollment Groups pro onboarding zařízení
  • Schopnost vytvářet a konfigurovat Scheduled Jobs
  • Podpora programového vytváření Application Dashboard prostřednictvím rozhraní REST API
  • Podpora nemodelovaných vlastností a příkazů pro Device
  • Možnost vypsat seznam zařízení v rámci Device Group
  • Souhrn průběhu podpory z úlohy
  • Odebrané pole názvu z Device Relationship

2022-05-31

Naše nejnovější verze ga z 31. května 2022 zlepšuje dříve existující 1.0 verzi a je plně zpětně kompatibilní. K dnešnímu 1.0 dne je tato verze označená jako deprecation a do května 2025 pro ni budeme chtít ukončit podporu. Tady je sada aktualizací zachycených v této verzi:

  • Podpora konfigurace úložiště pro nahrávání souborů
  • Podpora CRUD skupiny zařízení
  • Podpora CRUD organizace
  • Podpora organizace pro zařízení, role, uživatele a tokeny rozhraní API

1.2-Preview (Deprecated)

Tato 1.2-preview verze průběžně vylepšuje koncové body rozhraní API z předchozích verzí Preview a přidává podporu následujících funkcí:

  • Podpora CRUD skupiny zařízení
  • Nový typ úlohy pro podporu migrace šablon zařízení

1.0

První verze ga rozhraní REST API pro Azure IoT Central, která zachycuje podporu pro následující koncové body: zařízení, seznam rolí, uživatele, šablony zařízení a tokeny rozhraní API. Další informace o jednotlivých koncových bodech najdete tady.

  • Uživatelé bez podpory organizace
  • Seznam rolí bez podpory organizace
  • Podpora CRUD zařízení, vlastností, příkazů, přihlašovacích údajů a ověření identity
  • Tokeny rozhraní API bez podpory organizace
  • Šablona zařízení bez podpory PATCH

1.1-Preview (Deprecated)

Tato verze umožňuje podporu DTDL v2 v rámci rozhraní REST API pro Azure IoT Central. Zahrnuje zásadní změny ze starší preview verze (nyní zastaralé).

  • DTDLv2 si přečtěte další podrobnosti.
  • Podpora vztahů zařízení.
  • Podpora konfigurace FileUpload.
  • Podpora organizace.
  • Podpora dotazů na telemetrii zařízení
  • Podpora úloh.
  • Odebrali jsme starší podporu průběžného exportu dat.
  • Přidání podpory exportu a cíle exportu dat v2
  • Odebrání rozhraní API/devices/{deviceId}/cloudProperties pomocí rozhraní API/devices/{deviceId}/properties.
  • Vlastnosti a telemetrie zařízení v rámci zděděného rozhraní se nebudou považovat za kořenovou vlastnost a kořenovou telemetrii.
  • Podpora oprav šablon zařízení
  • Podpora manifestu Edge ze šablony zařízení

Preview (Deprecated & Removed)

První verze veřejného rozhraní API služby Azure IoT Central s podporou pouze pro DTDL v1 je nyní zastaralá a odebraná z koncových bodů rozhraní REST API.

Viz také