Azure IoT Central 資料平面 REST API 的 API 版本

本文列出適用于 Azure IoT Central 之 REST API 的目前和過去版本。

穩定版本

這些版本是穩定版本，可用來使用 Azure IoT Central 開發生產解決方案。

預覽版本會發行以測試新功能、收集意見反應，以及探索並修正問題。預覽 API 可在補充使用規定下取得，不建議用於生產工作負載。

2022 年 10 月 31 日 Azure IoT Central REST 資料平面 API 的預覽版本提供現有端點的一系列改善，並新增數個新的端點，以啟用下列重要功能。

目前查詢 API 的屬性查詢功能不再受到支援，且速率限制為每分鐘一個要求。

注意

此功能將于 2023 年 6 月 30 日移除。
支援建立和管理「Microsoft Edge 部署資訊清單」的生命週期。

注意

這些資訊清單現在已與裝置範本分離，而且可以獨立管理。
從 'DeviceTemplate' 定義中移除 'deploymentManifest'。根據上述變更，部署資訊清單現在無關。

注意

此更新是先前 2022-06-30-preview 版本中的重大變更行為。
新的 'iotEdge' 類型支援已新增至 'Device' 實體，作為 'type： string[]'。此欄位可讓使用者將裝置識別為已啟用IoT Edge裝置。此欄位是選擇性類型，您可以繼續建立和管理裝置實例，而不需要它。
```
{

    "type": ["iotEdge"]

}
```
支援新的 applyDeploymentManifest 路由至 Device 。這項作業可讓您將IoT Edge部署資訊清單與裝置實例產生關聯。
支援要設定 FileUpload 的新選擇性欄位 readAccess 。
在 idScope 實體內 EnrollmentGroup 支援以方便存取。
已更新對具有新參數的分頁支援，包括 maxpagesize 、 filterorderby 。而且先前支援的參數，包括 $filter 、 $top$orderby 現在已淘汰。
支援新的 deviceManifestMigration 作業類型。這個新的作業類型可讓您管理 Edge 裝置的車隊，並為其設定 deploymentManifest 。

我們在 2022 年 7 月 31 日的最新 GA 版本可改善先前現有的 2022-05-31 版本，並完全回溯相容。自今天起，版本 2022-05-31 現在已標示為 deprecation ，我們將會在 2025 年 7 月結束支援。以下是在此版本中擷取的一組更新：

2022 年 6 月 30 日 Azure IoT Central REST 資料平面 API 的預覽版本提供現有端點的一系列改善，並新增下列重要功能的支援：

我們在 2022 年 5 月 31 日的最新 GA 版本可改善先前現有的 1.0 版本，且完全回溯相容。自今天起，版本 1.0 現在已標示 deprecation 為，我們將會在 2025 年 5 月結束支援。以下是在此版本中擷取的一組更新：

此 1.2-preview 版本會持續改善先前預覽版本的 API 端點，並新增下列功能的支援：

Azure IoT Central 的第一個 GA REST API 版本，可擷取下列端點的支援：裝置、角色清單、使用者、裝置範本和 API 權杖。您可以在這裡深入瞭解每個端點。

此版本可在 Azure IoT Central 的 REST API 介面內支援 DTDL v2。它包含舊 preview 版的重大變更 (現在已被取代) 。

DTDLv2 對齊方式，閱讀更多詳細資料。
裝置關聯性支援。
FileUpload 組態支援。
組織支援。
裝置遙測查詢支援。
作業支援。
已移除舊版連續資料匯出支援。
新增資料匯出 V2 匯出/目的地支援。
已使用 api/devices/{deviceId}/cloudProperties 移除 api/devices/{deviceId}/properties。
繼承介面下的裝置屬性和遙測不會被視為根屬性和根遙測。
裝置範本修補支援。
來自裝置範本的 Edge 資訊清單支援。

第一版的 Azure IoT Central 公用 API 僅支援 DTDL v1 ，現在已從 REST API 端點淘汰並移除。