API-Versionen der REST-APIs der Azure IoT Central-Datenebene

In diesem Artikel werden die aktuellen und früheren Versionen der REST-APIs für Azure IoT Central aufgeführt.

Stabile Versionen

Diese Versionen sind die stabilen Releases, die zum Entwickeln von Produktionslösungen mit Azure IoT Central verwendet werden können.

Vorschauversionen

Vorschauversionen werden veröffentlicht, um neue Funktionen zu testen, Feedback zu sammeln und Probleme zu ermitteln und zu beheben. Vorschau-APIs sind unter Zusätzliche Nutzungsbedingungen verfügbar und werden für Produktionsworkloads nicht empfohlen.

Versionshinweise

2022-10-31-preview

Die Vorschauversion der Azure IoT Central-REST-Datenebenen-API vom 31. Oktober 2022 bietet eine Reihe von Verbesserungen an vorhandenen Endpunkten und fügt mehrere neue Endpunkte hinzu, um die folgenden Schlüsselfunktionen zu ermöglichen.

• Die Eigenschaftsabfragefunktion der aktuellen Abfrage-API wird nicht mehr unterstützt und hat die Rate auf eine Anforderung pro Minute beschränkt.

  Hinweis

  Dieses Feature wird am 30. Juni 2023 entfernt.

• Unterstützung für das Erstellen und Verwalten des Lebenszyklus für "Microsoft Edge-Bereitstellungsmanifeste".

  Hinweis

  Diese Manifeste wurden jetzt von den Gerätevorlagen entkoppelt und können unabhängig verwaltet werden.

• Entfernen von "deploymentManifest" aus der Definition "DeviceTemplate". Gemäß der obigen Änderung sind Bereitstellungsmanifeste jetzt unabhängig.

  Hinweis

  Dieses Update ist ein Breaking Change-Verhalten gegenüber dem vorherigen Release 2022-06-30-preview.

• Unterstützung für einen neuen Typ "iotEdge" wurde der Entität "Device" als "type: string[]" hinzugefügt. Mit diesem Feld kann der Benutzer ein Gerät als IoT Edge fähiges Gerät identifizieren. Dieses Feld ist ein optionaler Typ, und Sie können geräteinstanzen auch ohne ihn erstellen und verwalten.

  
  {
  
      "type": ["iotEdge"]
  
  }
  
  

• Unterstützung für eine neue applyDeploymentManifest Route zu Device. Mit diesem Vorgang können Sie einer Geräteinstanz ein IoT Edge Bereitstellungsmanifest zuordnen.

• Unterstützung für ein neues optionales Feld readAccess für die FileUpload Konfiguration.

• Unterstützung für idScope innerhalb der EnrollmentGroup Entität für den bequemen Zugriff.

• Die Unterstützung für paging mit neuen Parametern wie maxpagesize, , filterwurde orderbyaktualisiert. Und die zuvor unterstützten Parameter, einschließlich $filter, $orderby$topwurden jetzt eingestellt.

• Unterstützung für neuen deviceManifestMigration Auftragstyp. Mit diesem neuen Auftragstyp können Sie Ihre Flotte von Edge-Geräten verwalten und eine deploymentManifest für sie konfigurieren.

2022-07-31

Unser neuestes GA-Release vom 31. Juli 2022 verbessert das zuvor vorhandene 2022-05-31 Release und ist vollständig abwärtskompatibel. Ab heute ist das 2022-05-31 Release für gekennzeichnet deprecation , und wir werden die Unterstützung dafür bis Juli 2025 beenden. Im Folgenden finden Sie eine Reihe von Updates, die in dieser Version erfasst wurden:

• Aufträge mit Statusunterstützung
• Unterstützung geplanter Aufträge
• Unterstützung für Geräteregistrierungsgruppen
• Unterstützung für Gerätebeziehungen
• Gerätegruppenlistengeräteunterstützung

2022-06-30-preview

Die Vorschauversion der Azure IoT Central-REST-Datenebenen-API vom 30. Juni 2022 bietet eine Reihe von Verbesserungen an vorhandenen Endpunkten und fügt Unterstützung für die folgenden wichtigen Funktionen hinzu:

• Unterstützung für das Erstellen und Verwalten Enrollment Groups für das Onboarding von Geräten
• Möglichkeit zum Erstellen und Konfigurieren Scheduled Jobs
• Unterstützung für die programmgesteuerte Erstellung Application Dashboard über die REST-API
• Unterstützung für nicht modellierte Eigenschaften und Befehle für Device
• Möglichkeit zum Auflisten von Geräten in einem Device Group
• Zusammenfassung des Supportstatus vom Auftrag
• Feld "Name" aus entfernt Device Relationship

2022-05-31

Unser neuestes GA-Release vom 31. Mai 2022 verbessert das zuvor vorhandene 1.0 Release und ist vollständig abwärtskompatibel. Ab heute ist das 1.0 Release für gekennzeichnet deprecation , und wir werden die Unterstützung dafür bis Mai 2025 beenden. Im Folgenden finden Sie eine Reihe von Updates, die in dieser Version erfasst wurden:

• Unterstützung für die Dateiuploadspeicherkonfiguration
• Crud-Unterstützung für Gerätegruppen
• Crud-Unterstützung der Organisation
• Organisationsunterstützung für Geräte, Rollen, Benutzer und API-Token

1.2-Preview (Deprecated)

Das 1.2-preview Release verbessert kontinuierlich unsere API-Endpunkte aus früheren Vorschauversionen und fügt Unterstützung für die folgenden Features hinzu:

• CruD-Unterstützung für Gerätegruppen
• Neuer Auftragstyp zur Unterstützung der Migration von Gerätevorlagen

1.0

Das erste GA-REST-API-Release für Azure IoT Central, das die Unterstützung für die folgenden Endpunkte erfasst: Geräte, Rollenliste, Benutzer, Gerätevorlagen und API-Token. Weitere Informationen zu den einzelnen Endpunkten finden Sie hier.

• Benutzer ohne Organisationsunterstützung.
• Rollenliste ohne Organisationsunterstützung.
• Geräte CRUD, Eigenschaften, Befehle, Anmeldeinformationen, Nachweisunterstützung.
• API-Token ohne Organisationsunterstützung.
• Gerätevorlage ohne PATCH-Unterstützung.

1.1-Preview (Deprecated)

Dieses Release ermöglicht die Unterstützung für DTDL v2 innerhalb der REST-API-Oberfläche für Azure IoT Central. Es enthält Breaking Changes gegenüber der Legacyversion preview (jetzt veraltet).

• DTDLv2 Ausrichtung, lesen Sie weitere Details.
• Unterstützung der Gerätebeziehung.
• Unterstützung der FileUpload-Konfiguration.
• Organisationsunterstützung.
• Unterstützung von Gerätetelemetrieabfragen.
• Unterstützung von Aufträgen.
• Unterstützung für den fortlaufenden Datenexport wurde entfernt.
• Unterstützung für Den Datenexport V2-Export/Ziel hinzugefügt.
• Api/devices/{deviceId}/cloudProperties mithilfe von api/devices/{deviceId}/properties entfernt.
• Geräteeigenschaften und Telemetriedaten unter der geerbten Schnittstelle werden nicht als Stammeigenschafts- und Stammtelemetriedaten behandelt.
• Unterstützung für Das Patchen von Gerätevorlagen.
• Unterstützung des Edgemanifests über die Gerätevorlage.

Preview (Deprecated & Removed)

Die erste Version der öffentlichen Azure IoT Central-API mit Nur-Unterstützung DTDL v1 wurde jetzt veraltet und aus unseren REST-API-Endpunkten entfernt.

Siehe auch

• Häufige Fehlercodes
• Authentifizierung
• Drosselung