你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
Azure IoT Central 数据平面 REST API 的 API 版本
本文列出了 Azure IoT Central 的 REST API 的当前版本和过去版本。
稳定版本
这些版本是可用于使用 Azure IoT Central 开发生产解决方案的稳定版本。
| API 版本 | 规格 | API 更新 |
|---|---|---|
2022-07-31 (最新) |
Swagger 规范 | 发行说明 |
2022-05-31（已弃用） |
Swagger 规范 | 发行说明 |
1.0（已弃用） |
Swagger 规范 | 发行说明 |
预览版
发布预览版用于测试新功能、收集反馈以及发现和修复问题。 预览版 API 在 补充使用条款下提供，不建议用于生产工作负荷。
| API 版本 | 规格 | API 更新 |
|---|---|---|
2022-10-31-preview (最新) |
Swagger 规范 | 发行说明 |
2022-06-30-preview（已弃用） |
Swagger 规范 | 发行说明 |
1.2-Preview（已弃用） |
Swagger 规范 | 发行说明 |
1.1-Preview（已弃用） |
Swagger 规范 | 发行说明 |
发行说明
2022-10-31-preview
2022 年 10 月 31 日发布的 Azure IoT Central REST 数据平面 API 预览版对现有终结点进行了一系列改进，并添加了几个新终结点来启用以下关键功能。
当前查询 API 的属性查询功能不再受支持，并且已将速率限制为每分钟一个请求。
注意
此功能将于 2023 年 6 月 30 日删除。
支持创建和管理“Microsoft Edge 部署清单”的生命周期。
注意
这些清单现已与设备模板分离，可以独立管理。
从“DeviceTemplate”定义中删除“deploymentManifest”。 根据上述更改，部署清单现在是独立的。
注意
此更新是上一个 2022-06-30-preview 版本中的中断性变更行为。
对新“iotEdge”类型的支持已作为“type： string[]”添加到“Device”实体。 此字段使用户能够将设备标识为已启用IoT Edge的设备。 此字段是一种可选类型，无需它，可以继续创建和管理设备实例。
{ "type": ["iotEdge"] }支持到
Device的新applyDeploymentManifest路由。 此操作使你能够将IoT Edge部署清单关联到设备实例。支持配置中新的可选字段
readAccessFileUpload。idScope支持 在实体内EnrollmentGroup方便访问。更新了使用新参数（包括
maxpagesize、、filterorderby）分页的支持。 以前支持的参数（包括$filter、$top）$orderby现已停用。支持新
deviceManifestMigration作业类型。 通过此新作业类型，可以管理 Edge 设备群并为它们配置deploymentManifest。
2022-07-31
我们于 2022 年 7 月 31 日发布的最新正式版改进了以前现有的 2022-05-31 版本，并且完全向后兼容。 截至今天，该 2022-05-31 版本现已标记为 ， deprecation 我们将在 2025 年 7 月之前终止对它的支持。 下面是此版本中捕获的一组更新：
- 支持进度状态的作业
- 计划作业支持
- 设备注册组支持
- 设备关系支持
- 设备组列出设备支持
2022-06-30-preview
2022 年 6 月 30 日 Azure IoT Central REST 数据平面 API 预览版为现有终结点提供了一系列改进，并增加了对以下关键功能的支持：
- 支持创建和管理
Enrollment Groups设备载入 - 能够创建和配置
Scheduled Jobs - 支持通过 REST API 以编程方式创建
Application Dashboard - 支持 的未建模属性和命令
Device - 能够列出 中的设备
Device Group - 作业中的支持进度摘要
- 从 中删除了名称字段
Device Relationship
2022-05-31
我们于 2022 年 5 月 31 日发布的最新正式版改进了以前现有的 1.0 版本，并且完全向后兼容。 从今天起，该 1.0 版本现已标记为 ， deprecation 我们将在 2025 年 5 月之前终止对它的支持。 下面是此版本中捕获的一组更新：
- 文件上传存储配置支持
- 设备组 CRUD 支持
- 组织 CRUD 支持
- 组织对设备、角色、用户和 API 令牌的支持
1.2-Preview (Deprecated)
该 1.2-preview 版本不断改进以前的预览版中的 API 终结点，并添加了对以下功能的支持：
- 设备组 CRUD 支持
- 支持设备模板迁移的新作业类型
1.0
适用于 Azure IoT Central 的第一个 GA REST API 版本，用于捕获对以下终结点的支持：设备、角色列表、用户、设备模板和 API 令牌。 可在此处详细了解每个 终结点。
- 没有组织支持的用户。
- 没有组织支持的角色列表。
- 设备 CRUD、属性、命令、凭据、证明支持。
- 没有组织支持的 API 令牌。
- 不支持 PATCH 的设备模板。
1.1-Preview (Deprecated)
此版本支持 Azure IoT Central 的 REST API 图面中的 DTDL v2。 它包括旧版 (现已弃用) 的重大更改 preview 。
-
DTDLv2对齐，请阅读 更多详细信息。 - 设备关系支持。
- FileUpload 配置支持。
- 组织支持。
- 设备遥测查询支持。
- 作业支持。
- 删除了旧版连续数据导出支持。
- 添加数据导出 V2 导出/目标支持。
- 使用 api/devices/{deviceId}/properties 删除了 api/devices/{deviceId}/cloudProperties。
- 继承接口下的设备属性和遥测不会被视为根属性和根遥测。
- 设备模板修补支持。
- 来自设备模板的边缘清单支持。
Preview (Deprecated & Removed)
Azure IoT Central 公共 API 的第一个版本（仅支持 DTDL v1 ）现已弃用并从 REST API 终结点中删除。