Версии API REST API плоскости данных Azure IoT Central

В этой статье перечислены текущие и предыдущие версии REST API для Azure IoT Central.

Стабильные версии

Эти версии являются стабильными выпусками, которые можно использовать для разработки рабочих решений с помощью 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

Предварительная версия REST API плоскости данных Azure IoT Central от 31 октября 2022 г. предоставляет ряд улучшений для существующих конечных точек и добавляет несколько новых конечных точек для реализации следующих основных возможностей.

  • Функция запроса свойств текущего API запросов больше не поддерживается и ограничивает частоту одним запросом в минуту.

    Примечание

    Эта функция будет удалена до 30 июня 2023 г.

  • Поддержка создания жизненного цикла манифестов развертывания Microsoft Edge и управления ими.

    Примечание

    Теперь эти манифесты отделены от шаблонов устройств и могут управляться независимо.

  • Удаление deploymentManifest из определения DeviceTemplate. Согласно приведенному выше изменению манифесты развертывания теперь независимы.

    Примечание

    Это обновление является критическим изменением по сравнению с предыдущим выпуском 2022-06-30-preview.

  • Добавлена поддержка нового типа iotEdge в сущность Device в виде типа string[]. Это поле позволяет пользователю идентифицировать устройство как устройство с поддержкой IoT Edge. Это поле является необязательным типом, и вы можете продолжать создавать экземпляры устройств и управлять ими без него.

    
{

    "type": ["iotEdge"]

}

  • Поддержка нового applyDeploymentManifest маршрута к Device. Эта операция позволяет связать манифест развертывания IoT Edge с экземпляром устройства.

  • Поддержка нового необязательного поля readAccess для FileUpload конфигурации.

  • idScope Поддержка в сущности EnrollmentGroup для удобного доступа.

  • Обновлена поддержка разбиения по страницам с новыми параметрами, включая maxpagesize, filter, orderby. Ранее поддерживаемые параметры, включая $filter, $top$orderby теперь прекращены.

  • Поддержка нового deviceManifestMigration типа задания. Этот новый тип задания позволяет управлять парком устройств Edge и настраивать deploymentManifest для них.

2022-07-31

Наш последний общедоступный выпуск от 31 июля 2022 г. улучшает ранее существующий 2022-05-31 выпуск и полностью совместим с обратной совместимостью. На сегодняшний день выпуск помечен для deprecation , 2022-05-31 и мы будем ожидать прекращения поддержки к июлю 2025 г. Ниже приведен набор обновлений, захваченных в этом выпуске:

  • Задания с поддержкой состояния хода выполнения
  • Поддержка запланированных заданий
  • Поддержка групп регистрации устройств
  • Поддержка связей устройств
  • Поддержка списка устройств в группах устройств

2022-06-30-preview

Предварительная версия REST API плоскости данных Azure IoT Central от 30 июня 2022 г. предоставляет ряд улучшений существующих конечных точек и добавляет поддержку следующих основных возможностей:

  • Поддержка создания устройств и управления ими Enrollment Groups
  • Возможность создания и настройки Scheduled Jobs
  • Поддержка программного создания Application Dashboard с помощью REST API
  • Поддержка немоделированных свойств и команд для Device
  • Возможность перечисления устройств в Device Group
  • Сводка о ходе выполнения поддержки из задания
  • Удалено поле имени из Device Relationship

2022-05-31

Наш последний общедоступный выпуск от 31 мая 2022 г. улучшает ранее существующий 1.0 выпуск и полностью совместим с обратной совместимостью. На сегодняшний день выпуск помечен дляdeprecation, 1.0 и мы будем ожидать прекращения поддержки к маю 2025 г. Ниже приведен набор обновлений, захваченных в этом выпуске:

  • Поддержка конфигурации хранилища отправки файлов
  • Поддержка CRUD для групп устройств
  • Поддержка CRUD организации
  • Поддержка организации на устройствах, ролях, пользователях и маркерах API

1.2-Preview (Deprecated)

Выпуск 1.2-preview постоянно улучшает наши конечные точки API по сравнению с предыдущими предварительными версиями и добавляет поддержку следующих функций:

  • Поддержка CRUD для групп устройств
  • Новый тип задания для поддержки миграции шаблонов устройств

1.0

Первый общедоступный выпуск REST API для Azure IoT Central, который охватывает поддержку следующих конечных точек: устройства, список ролей, пользователи, шаблоны устройств и маркеры API. Дополнительные сведения о каждой из конечных точек см. здесь.

  • Пользователи без поддержки организации.
  • Список ролей без поддержки организации.
  • Устройства CRUD, свойства, команды, учетные данные, поддержка аттестации.
  • Маркеры API без поддержки организации.
  • Шаблон устройства без поддержки PATCH.

1.1-Preview (Deprecated)

Этот выпуск включает поддержку DTDL версии 2 в области REST API для Azure IoT Central. Он включает критические изменения по сравнению с устаревшей версией preview (теперь не рекомендуется).

  • DTDLv2 выравнивание, дополнительные сведения см. в статье.
  • Поддержка отношений устройств.
  • Поддержка конфигурации FileUpload.
  • Поддержка организации.
  • Поддержка запросов телеметрии устройств.
  • Поддержка заданий.
  • Удалена устаревшая поддержка непрерывного экспорта данных.
  • Добавлена поддержка экспорта и назначения экспорта данных версии 2.
  • Удален api/devices/{deviceId}/cloudProperties с помощью api/devices/{deviceId}/properties.
  • Свойства устройства и данные телеметрии в наследуемом интерфейсе не будут рассматриваться как корневое свойство и корневая телеметрия.
  • Поддержка исправлений шаблонов устройств.
  • Поддержка манифеста Edge из шаблона устройства.

Preview (Deprecated & Removed)

Первая версия общедоступного API Azure IoT Central с поддержкой DTDL v1 только является устаревшей и удалена из конечных точек REST API.

См. также раздел

  • Last updated on