Azure IoT Central версии 3 (предварительная версия)

Azure IoT Central упрощает подключение, мониторинг и управление устройствами Интернета вещей в большом масштабе. С помощью соединителя IoT Central V3 можно активировать рабочие процессы при запуске правила и выполнять действия, выполняя команды, обновляя свойства, получая данные телеметрии с устройств и многое другое. Используйте этот соединитель с приложением Azure IoT Central версии 3.

Этот соединитель доступен в следующих продуктах и регионах:

Услуга	Class	Регионы
Copilot Studio	Премия	Все регионы Power Automate , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD)
Логические приложения	Стандарт	Все регионы Logic Apps , кроме следующих: — Регионы Azure для государственных организаций — Регионы Azure Для Китая - Министерство обороны США (DoD)
Power Apps	Премия	Все регионы Power Apps , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD)
Power Automate	Премия	Все регионы Power Automate , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD)

Контакт
Имя	Техническая поддержка Azure IoT Central
URL	https://aka.ms/iotcentral-create-technical-support-ticket-trial

Метаданные соединителя
Publisher	Корпорация Майкрософт
Веб-сайт	https://azure.microsoft.com/services/iot-central/
Политика конфиденциальности	https://privacy.microsoft.com
Категории	Интернет вещей

Соединитель Azure IoT Central версии 3 можно использовать для подключения приложения Azure IoT Central V3 к рабочим процессам. Соединитель можно использовать для запуска рабочих процессов при запуске правила. Его можно использовать для получения последних сведений с устройств Интернета вещей, таких как данные телеметрии и свойства. Кроме того, вы можете использовать его для обновления устройств Интернета вещей, отправляя команды и обновляя соответствующие сайты.

Предпосылки

Для использования этого соединителя необходимо быть пользователем в приложении Azure IoT Central версии 3You-Go с оплатой по мере использования.
Необходимо использовать рабочую или учебную учетную запись Идентификатора Microsoft Entra.

Получение учетных данных

Чтобы добавить этот соединитель в рабочий процесс, необходимо сначала войти в рабочую или учебную учетную запись Microsoft Entra ID, которая является пользователем в приложении Azure IoT Central, к которому вы хотите подключиться.

Примечания к релизу

Сентябрь 2021 года

Теперь соединитель Azure IoT Central версии 3 обновлен для выравнивания с общедоступной областью REST API версии 1.0 . Все действия соединителя теперь поддерживают формат DTDLv2 и поддержку моделей на основе DTDLv1 устарели.
Действия для Run a device command, Get/Update device propertiesи Get device telemetry value были обновлены, чтобы добавить поддержку последних функций шаблона устройства в Azure IoT Central. Теперь эти действия поддерживают как корневые, так и компоненты.
Добавлен новый набор действий модуля устройства. Эти действия позволяют создавать рабочие процессы, взаимодействующие с командами, свойствами, телеметриями модулей устройств и компонентами модулей.
Действия, которые Get/Create/Update/Delete a device были обновлены, чтобы соответствовать последнему REST API Azure IoT Central.
Действия Get device cloud properties и Update device cloud properties теперь являются частью Get device properties и Update device properties. Новые действия позволяют рабочим процессам взаимодействовать как с свойствами устройств, так и с облачными свойствами одновременно.

Уведомление об удалении: к концу CY21 действия, помеченные как устаревшие в списке ниже, больше не будут доступны при создании новых рабочих процессов. Существующие рабочие процессы, ссылающиеся на эти действия, будут продолжать работать до марта 2022 года. Мы рекомендуем обновить рабочие процессы, чтобы воспользоваться новыми объявленными действиями, которые теперь поддерживаются в Azure IoT Central.

Ноябрь 2021 г.

Добавлены новые действия для перечисления устройств и шаблонов устройств для приложения Azure IoT Central. Эти действия включают поддержку разбиения на страницы.
В соединитель добавлен новый набор действий управления пользователями, позволяющий рабочим процессам создавать, обновлять, перечислять и удалять пользователей приложения.
Рабочие процессы теперь могут получить последнее выполнение команды устройства с помощью новых Get device command response действий. Этот набор действий поддерживает команды корневого, компонента и модуля.

Известные проблемы и ограничения

Чтобы использовать этот соединитель в Microsoft Power Automate, необходимо войти в приложение IoT Central по крайней мере один раз. В противном случае приложение не появится в раскрывающемся списке "Приложение"
Личные учетные записи Майкрософт (например@hotmail.com, @live.com@outlook.com домены) не поддерживаются для входа в соединитель IoT Central. Необходимо использовать рабочую или учебную учетную запись Идентификатора Microsoft Entra.

Создание подключения

Соединитель поддерживает следующие типы проверки подлинности:


Credentials	Credentials	Все регионы	Недоступен для совместного использования
По умолчанию [не рекомендуется]	Этот параметр предназначен только для старых подключений без явного типа проверки подлинности и предоставляется только для обратной совместимости.	Все регионы	Недоступен для совместного использования

Credentials

Идентификатор проверки подлинности: 1stparty

Применимо: все регионы

Credentials

Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.

По умолчанию [не рекомендуется]

Применимо: все регионы

Этот параметр предназначен только для старых подключений без явного типа проверки подлинности и предоставляется только для обратной совместимости.

Ограничения регулирования

Имя	Вызовы	Период обновления
Вызовы API для каждого подключения	100	60 секунд

Действия

Возобновление задания на неудачных устройствах	Выполните повторное выполнение существующего задания на всех неудачных устройствах.
Возобновление остановленного задания	Возобновление выполнения существующего остановленного задания.
Вывод списка групп устройств	Получение списка групп устройств в приложении.
Вывод списка запланированных заданий	Получение списка запланированных заданий в приложении.
Вывод списка шаблонов устройств	Получение списка шаблонов устройств в приложении.
Выполнение команды компонента	Выполните команду в компоненте.
Выполнение команды компонента модуля	Выполните команду в компоненте модуля.
Выполнение команды модуля	Выполните команду в модуле.
Выполнение команды устройства	Выполните команду на устройстве.
Выполнение команды устройства (не рекомендуется)	Выполните команду на устройстве (не рекомендуется).
Обновление запланированного задания	Обновите существующее запланированное задание по идентификатору.
Обновление облачных свойств устройства (устарело)	Обновите все значения облачных свойств устройства по идентификатору устройства (не рекомендуется).
Обновление пользователя	Обновление пользователя в приложении с помощью исправления
Обновление свойств модуля.	Обновите все значения свойств модуля.
Обновление свойств устройства	Обновите все значения свойств устройства по идентификатору устройства.
Обновление свойств устройства (не рекомендуется)	Обновите все значения свойств устройства по идентификатору устройства (не рекомендуется).
Обновление связи устройства	Обновите существующее отношение устройства между данным устройством и новым устройством с идентификатором устройства и идентификатором связи.
Остановка выполняемого задания	Остановите выполнение задания, выполняемого в настоящее время.
Перечисление организаций	Получение списка организаций в приложении.
Перечисление пользователей	Получение списка пользователей в приложении
Перечисление ролей	Получение списка ролей в приложении.
Получение группы устройств	Получение сведений о существующей группе устройств по идентификатору.
Получение заданий по идентификатору запланированного задания	Получение списка заданий для определения запланированного задания.
Получение задания	Получение сведений о существующем задании по идентификатору.
Получение запланированного задания	Получение сведений о существующем запланированном задании по идентификатору.
Получение значения телеметрии компонента	Получение последнего значения телеметрии из компонента.
Получение значения телеметрии компонента модуля	Получение последнего значения телеметрии из компонента модуля.
Получение значения телеметрии модуля	Получение последнего значения телеметрии из модуля.
Получение значения телеметрии устройства	Получите последнее значение телеметрии с устройства.
Получение значения телеметрии устройства (не рекомендуется)	Получите последнее значение телеметрии с устройства (не рекомендуется).
Получение организации	Получение сведений о существующей организации по идентификатору.
Получение ответа команды компонента	Получите последний ответ для команды компонента устройства.
Получение ответа команды компонента модуля	Получите последний ответ для команды компонента модуля.
Получение ответа команды модуля	Получение последнего ответа для команды модуля устройства
Получение ответа команды устройства	Получите последний ответ для команды устройства.
Получение пользователя	Получение пользователя по идентификатору
Получение роли	Получение роли по идентификатору.
Получение свойств модуля	Получение всех значений свойств модуля.
Получение свойств облака устройства (не рекомендуется)	Получение всех значений облачных свойств устройства по идентификатору устройства (не рекомендуется).
Получение свойств устройства	Получение всех значений свойств устройства по идентификатору устройства.
Получение свойств устройства (не рекомендуется)	Получение всех значений свойств устройства по идентификатору устройства (не рекомендуется).
Получение связи устройства	Получение сведений о существующей связи устройства по идентификатору устройства и идентификатору связи.
Получение состояния устройства	Получение списка состояний отдельных устройств по идентификатору задания.
Получение устройств по идентификатору группы устройств	Получение списка устройств в группе устройств в приложении.
Получение устройства по его идентификатору	Получение сведений о существующем устройстве по идентификатору устройства.
Получение устройства по идентификатору (не рекомендуется)	Получение сведений о существующем устройстве по идентификатору устройства (не рекомендуется).
получить шаблон устройства по идентификатору;	Получение сведений о существующем шаблоне устройства по идентификатору.
Создание группы устройств	Создайте или обновите группу устройств.
Создание задания	Создайте и выполните новое задание с помощью его определения задания.
Создание запланированного задания	Создайте и выполните новое запланированное задание с помощью определения задания.
Создание или обновление устройства	Создайте устройство или обновите существующее по идентификатору устройства.
Создание или обновление устройства (не рекомендуется)	Создайте устройство или обновите существующее по идентификатору устройства. (не рекомендуется)
Создание или обновление устройства (не рекомендуется)	Создайте устройство или обновите существующее по идентификатору устройства (не рекомендуется).
Создание организации	Создание организации.
Создание пользователя	Создание пользователя в приложении
Создание связи устройства	Создайте связь устройства между данным устройством и новым устройством с идентификатором устройства и идентификатором связи.
Список заданий	Получение списка заданий в приложении.
Список связей	Вывод списка всех связей на основе идентификатора устройства.
Список устройств	Получение списка устройств в приложении.
Удаление группы устройств	Удаление существующей группы устройств по идентификатору
Удаление запланированного задания	Удалите существующее запланированное задание по идентификатору.
Удаление организации	Удаление существующей организации по идентификатору
Удаление пользователя	Удаление пользователя
Удаление связи устройства	Удаление существующей связи устройства по идентификатору устройства и идентификатору связи.
Удаление устройства	Удалите существующее устройство по идентификатору устройства.
Удаление устройства (не рекомендуется)	Удалите существующее устройство по идентификатору устройства (не рекомендуется).
удалить шаблон устройства;	Удалите существующий шаблон устройства по идентификатору.

Возобновление задания на неудачных устройствах

Идентификатор операции:: Jobs_Rerun

Выполните повторное выполнение существующего задания на всех неудачных устройствах.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Application	application	True	string	Уникальный идентификатор приложения.
Идентификатор задания	job_id	True	string	Уникальный идентификатор задания.
Идентификатор повторного запуска	rerun_id	True	string	Уникальный идентификатор повторного запуска.

Возвращаемое значение

Определение задания.

Тело: JobStatic

Возобновление остановленного задания

Идентификатор операции:: Jobs_Resume

Возобновление выполнения существующего остановленного задания.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Application	application	True	string	Уникальный идентификатор приложения.
Идентификатор задания	job_id	True	string	Уникальный идентификатор задания.

Вывод списка групп устройств

Идентификатор операции:: DeviceGroups_List

Получение списка групп устройств в приложении.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Application	application	True	string	Уникальный идентификатор приложения.

Возвращаемое значение

Страницные результаты групп устройств.

Тело: DeviceGroupCollection

Вывод списка запланированных заданий

Идентификатор операции:: ScheduledJobs_List

Получение списка запланированных заданий в приложении.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Application	application	True	string	Уникальный идентификатор приложения.

Возвращаемое значение

Выходные данные этой операции являются динамическими.

Вывод списка шаблонов устройств

Идентификатор операции:: DeviceTemplates_List_V1

Получение списка шаблонов устройств в приложении.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Application	application	True	string	Уникальный идентификатор приложения.

Возвращаемое значение

Тело: DeviceTemplateCollectionV1

Выполнение команды компонента

Идентификатор операции:: Devices_RunComponentCommand_V1

Выполните команду в компоненте.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Application	application	True	string	Уникальный идентификатор приложения.
Идентификатор устройства	device_id	True	string	Уникальный идентификатор устройства.
Компонент устройства	component_name	True	string	Имя компонента устройства.
Команда устройства	command_name	True	string	Имя этой команды устройства.
Шаблон устройства	template		string	Определение шаблона устройства для устройства.
body	body	True	dynamic	Текст команды устройства.

Возвращаемое значение

Выходные данные этой операции являются динамическими.

Выполнение команды компонента модуля

Идентификатор операции:: Devices_RunModuleComponentCommand_V1

Выполните команду в компоненте модуля.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Application	application	True	string	Уникальный идентификатор приложения.
Идентификатор устройства	device_id	True	string	Уникальный идентификатор устройства.
Модуль устройства	module	True	string	Имя модуля устройства.
Компонент устройства	component_name	True	string	Имя компонента устройства.
Команда устройства	command_name	True	string	Имя этой команды устройства.
Шаблон устройства	template		string	Определение шаблона устройства для устройства.
body	body	True	dynamic	Текст команды устройства.

Возвращаемое значение

Выходные данные этой операции являются динамическими.

Выполнение команды модуля

Идентификатор операции:: Devices_RunModuleCommand_V1

Выполните команду в модуле.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Application	application	True	string	Уникальный идентификатор приложения.
Идентификатор устройства	device_id	True	string	Уникальный идентификатор устройства.
Модуль устройства	module	True	string	Имя модуля устройства.
Команда устройства	command_name	True	string	Имя этой команды устройства.
Шаблон устройства	template		string	Определение шаблона устройства для устройства.
body	body	True	dynamic	Текст команды устройства.

Возвращаемое значение

Выходные данные этой операции являются динамическими.

Выполнение команды устройства

Идентификатор операции:: Devices_RunCommand_V1

Выполните команду на устройстве.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Application	application	True	string	Уникальный идентификатор приложения.
Идентификатор устройства	device_id	True	string	Уникальный идентификатор устройства.
Команда устройства	command_name	True	string	Имя этой команды устройства.
Шаблон устройства	template		string	Определение шаблона устройства для устройства.
body	body	True	dynamic	Текст команды устройства.

Возвращаемое значение

Выходные данные этой операции являются динамическими.

Выполнение команды устройства (не рекомендуется)

Идентификатор операции:: Devices_ExecuteComponentCommand

Выполните команду на устройстве (не рекомендуется).

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Application	application	True	string	Уникальный идентификатор приложения.
Идентификатор устройства	device_id	True	string	Уникальный идентификатор устройства.
Компонент устройства	component_name	True	string	Имя компонента устройства.
Команда устройства	command_name	True	string	Имя этой команды устройства.
Идентификатор шаблона устройства	instanceOf		string	Определение шаблона устройства для устройства.
body	body	True	dynamic	Текст команды устройства.

Возвращаемое значение

Выходные данные этой операции являются динамическими.

Обновление запланированного задания

Идентификатор операции:: ScheduledJobs_Update

Обновите существующее запланированное задание по идентификатору.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Application	application	True	string	Уникальный идентификатор приложения.
Идентификатор запланированного задания	scheduled_job_id	True	string	Уникальный идентификатор запланированного задания.
Тип окончания расписания	scheduled_job_end_type		string	Как должно завершиться запланированное задание (не применяется к миграциям шаблонов устройств).
Тело	body	True	dynamic	Текст создания запланированного задания.

Возвращаемое значение

Определение запланированного задания.

Тело: ScheduledJobStatic

Обновление облачных свойств устройства (устарело)

Идентификатор операции:: Devices_UpdateCloudProperties

Обновите все значения облачных свойств устройства по идентификатору устройства (не рекомендуется).

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Application	application	True	string	Уникальный идентификатор приложения.
Идентификатор устройства	device_id	True	string	Уникальный идентификатор устройства.
Идентификатор шаблона устройства	instanceOf		string	Определение шаблона устройства для устройства.
body	body	True	dynamic	Свойства устройства.

Возвращаемое значение

Выходные данные этой операции являются динамическими.

Обновление пользователя

Идентификатор операции:: Users_Update_V1

Обновление пользователя в приложении с помощью исправления

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Application	application	True	string	Уникальный идентификатор приложения.
User	user_id	True	string	Уникальный идентификатор пользователя.
Тип пользователя	user_type		string	Тип пользователя.
Тело	body	True	dynamic	Текст обновления пользователя.

Возвращаемое значение

Выходные данные этой операции являются динамическими.

Обновление свойств модуля.

Идентификатор операции:: Devices_UpdateModuleProperties_V1

Обновите все значения свойств модуля.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Application	application	True	string	Уникальный идентификатор приложения.
Идентификатор устройства	device_id	True	string	Уникальный идентификатор устройства.
Модуль устройства	module	True	string	Имя модуля устройства.
Шаблон устройства	template		string	Определение шаблона устройства для устройства.
body	body	True	dynamic	Свойства устройства.

Возвращаемое значение

Выходные данные этой операции являются динамическими.

Обновление свойств устройства

Идентификатор операции:: Devices_UpdateProperties_V1

Обновите все значения свойств устройства по идентификатору устройства.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Application	application	True	string	Уникальный идентификатор приложения.
Идентификатор устройства	device_id	True	string	Уникальный идентификатор устройства.
Шаблон устройства	template		string	Определение шаблона устройства для устройства.
body	body	True	dynamic	Свойства устройства.

Возвращаемое значение

Выходные данные этой операции являются динамическими.

Обновление свойств устройства (не рекомендуется)

Идентификатор операции:: Devices_UpdateProperties

Обновите все значения свойств устройства по идентификатору устройства (не рекомендуется).

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Application	application	True	string	Уникальный идентификатор приложения.
Идентификатор устройства	device_id	True	string	Уникальный идентификатор устройства.
Идентификатор шаблона устройства	instanceOf		string	Определение шаблона устройства для устройства.
body	body	True	dynamic	Свойства устройства.

Возвращаемое значение

Выходные данные этой операции являются динамическими.

Обновление связи устройства

Идентификатор операции:: DeviceRelationships_Update

Обновите существующее отношение устройства между данным устройством и новым устройством с идентификатором устройства и идентификатором связи.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Application	application	True	string	Уникальный идентификатор приложения.
Идентификатор устройства	device_id	True	string	Уникальный идентификатор устройства.
Идентификатор связи	relationship_id	True	string	Уникальный идентификатор связи устройства.
Идентификатор связи устройства	id		string	Уникальный идентификатор связи устройства.
Идентификатор целевого объекта связи устройства	target	True	string	Идентификатор устройства источника (дочернего) устройства.

Возвращаемое значение

Тело: DeviceRelationshipStatic

Остановка выполняемого задания

Идентификатор операции:: Jobs_Stop

Остановите выполнение задания, выполняемого в настоящее время.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Application	application	True	string	Уникальный идентификатор приложения.
Идентификатор задания	job_id	True	string	Уникальный идентификатор задания.

Перечисление организаций

Идентификатор операции:: Organizations_List

Получение списка организаций в приложении.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Application	application	True	string	Уникальный идентификатор приложения.

Возвращаемое значение

Тело: OrganizationCollection

Перечисление пользователей

Идентификатор операции:: Users_List_V1

Получение списка пользователей в приложении

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Application	application	True	string	Уникальный идентификатор приложения.

Возвращаемое значение

Тело: UserCollectionV1

Перечисление ролей

Идентификатор операции:: Roles_List_V1

Получение списка ролей в приложении.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Application	application	True	string	Уникальный идентификатор приложения.

Возвращаемое значение

Тело: RoleCollectionV1

Получение группы устройств

Идентификатор операции:: DeviceGroups_Get

Получение сведений о существующей группе устройств по идентификатору.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Application	application	True	string	Уникальный идентификатор приложения.
Идентификатор группы устройств	device_group_id	True	string	Уникальный идентификатор группы устройств.

Возвращаемое значение

Определение группы устройств.

Тело: DeviceGroup

Получение заданий по идентификатору запланированного задания

Идентификатор операции:: ScheduledJobs_ListJobs

Получение списка заданий для определения запланированного задания.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Application	application	True	string	Уникальный идентификатор приложения.
Идентификатор запланированного задания	scheduled_job_id	True	string	Уникальный идентификатор запланированного задания.

Возвращаемое значение

Страницные результаты определений заданий, принадлежащих запланированному заданию.

Тело: ScheduledJobJobCollection

Получение задания

Идентификатор операции:: Jobs_Get

Получение сведений о существующем задании по идентификатору.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Application	application	True	string	Уникальный идентификатор приложения.
Идентификатор задания	job_id	True	string	Уникальный идентификатор задания.

Возвращаемое значение

Определение задания.

Тело: JobStatic

Получение запланированного задания

Идентификатор операции:: ScheduledJobs_Get

Получение сведений о существующем запланированном задании по идентификатору.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Application	application	True	string	Уникальный идентификатор приложения.
Идентификатор запланированного задания	scheduled_job_id	True	string	Уникальный идентификатор запланированного задания.

Возвращаемое значение

Выходные данные этой операции являются динамическими.

Получение значения телеметрии компонента

Идентификатор операции:: Devices_GetComponentTelemetryValue_V1

Получение последнего значения телеметрии из компонента.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Application	application	True	string	Уникальный идентификатор приложения.
Идентификатор устройства	device_id	True	string	Уникальный идентификатор устройства.
Компонент устройства	component_name	True	string	Имя компонента устройства.
Данные телеметрии устройства	telemetry_name	True	string	Имя телеметрии этого устройства.
Шаблон устройства	template		string	Определение шаблона устройства для устройства.

Возвращаемое значение

Выходные данные этой операции являются динамическими.

Получение значения телеметрии компонента модуля

Идентификатор операции:: Devices_GetModuleComponentTelemetryValue_V1

Получение последнего значения телеметрии из компонента модуля.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Application	application	True	string	Уникальный идентификатор приложения.
Идентификатор устройства	device_id	True	string	Уникальный идентификатор устройства.
Модуль устройства	module	True	string	Имя модуля устройства.
Компонент устройства	component_name	True	string	Имя компонента устройства.
Данные телеметрии устройства	telemetry_name	True	string	Имя телеметрии этого устройства.
Шаблон устройства	template		string	Определение шаблона устройства для устройства.

Возвращаемое значение

Выходные данные этой операции являются динамическими.

Получение значения телеметрии модуля

Идентификатор операции:: Devices_GetModuleTelemetryValue_V1

Получение последнего значения телеметрии из модуля.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Application	application	True	string	Уникальный идентификатор приложения.
Идентификатор устройства	device_id	True	string	Уникальный идентификатор устройства.
Модуль устройства	module	True	string	Имя модуля устройства.
Данные телеметрии устройства	telemetry_name	True	string	Имя телеметрии этого устройства.
Шаблон устройства	template		string	Определение шаблона устройства для устройства.

Возвращаемое значение

Выходные данные этой операции являются динамическими.

Получение значения телеметрии устройства

Идентификатор операции:: Devices_GetTelemetryValue_V1

Получите последнее значение телеметрии с устройства.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Application	application	True	string	Уникальный идентификатор приложения.
Идентификатор устройства	device_id	True	string	Уникальный идентификатор устройства.
Данные телеметрии устройства	telemetry_name	True	string	Имя телеметрии этого устройства.
Шаблон устройства	template		string	Определение шаблона устройства для устройства.

Возвращаемое значение

Выходные данные этой операции являются динамическими.

Получение значения телеметрии устройства (не рекомендуется)

Идентификатор операции:: Devices_GetComponentTelemetryValue

Получите последнее значение телеметрии с устройства (не рекомендуется).

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Application	application	True	string	Уникальный идентификатор приложения.
Идентификатор устройства	device_id	True	string	Уникальный идентификатор устройства.
Компонент устройства	component_name	True	string	Имя компонента устройства.
Данные телеметрии устройства	telemetry_name	True	string	Имя телеметрии этого устройства.
Идентификатор шаблона устройства	instanceOf		string	Определение шаблона устройства для устройства.

Возвращаемое значение

Выходные данные этой операции являются динамическими.

Получение организации

Идентификатор операции:: Organizations_Get

Получение сведений о существующей организации по идентификатору.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Application	application	True	string	Уникальный идентификатор приложения.
Идентификатор организации	organization_id	True	string	Уникальный идентификатор организации.

Возвращаемое значение

Тело: Organization

Получение ответа команды компонента

Идентификатор операции:: Devices_GetComponentCommandResponse_V1

Получите последний ответ для команды компонента устройства.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Application	application	True	string	Уникальный идентификатор приложения.
Идентификатор устройства	device_id	True	string	Уникальный идентификатор устройства.
Компонент устройства	component_name	True	string	Имя компонента устройства.
Команда устройства	command_name	True	string	Имя этой команды устройства.
Шаблон устройства	template		string	Определение шаблона устройства для устройства.

Возвращаемое значение

Выходные данные этой операции являются динамическими.

Получение ответа команды компонента модуля

Идентификатор операции:: Devices_GetModuleComponentCommandResponse_V1

Получите последний ответ для команды компонента модуля.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Application	application	True	string	Уникальный идентификатор приложения.
Идентификатор устройства	device_id	True	string	Уникальный идентификатор устройства.
Модуль устройства	module	True	string	Имя модуля устройства.
Компонент устройства	component_name	True	string	Имя компонента устройства.
Команда устройства	command_name	True	string	Имя этой команды устройства.
Шаблон устройства	template		string	Определение шаблона устройства для устройства.

Возвращаемое значение

Выходные данные этой операции являются динамическими.

Получение ответа команды модуля

Идентификатор операции:: Devices_GetModuleCommandResponse_V1

Получение последнего ответа для команды модуля устройства

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Application	application	True	string	Уникальный идентификатор приложения.
Идентификатор устройства	device_id	True	string	Уникальный идентификатор устройства.
Модуль устройства	module	True	string	Имя модуля устройства.
Команда устройства	command_name	True	string	Имя этой команды устройства.
Шаблон устройства	template		string	Определение шаблона устройства для устройства.

Возвращаемое значение

Выходные данные этой операции являются динамическими.

Получение ответа команды устройства

Идентификатор операции:: Devices_GetCommandResponse_V1

Получите последний ответ для команды устройства.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Application	application	True	string	Уникальный идентификатор приложения.
Идентификатор устройства	device_id	True	string	Уникальный идентификатор устройства.
Команда устройства	command_name	True	string	Имя этой команды устройства.
Шаблон устройства	template		string	Определение шаблона устройства для устройства.

Возвращаемое значение

Выходные данные этой операции являются динамическими.

Получение пользователя

Идентификатор операции:: Users_Get_V1

Получение пользователя по идентификатору

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Application	application	True	string	Уникальный идентификатор приложения.
User	user_id	True	string	Уникальный идентификатор пользователя.

Возвращаемое значение

Тело: UserStaticV1

Получение роли

Идентификатор операции:: Roles_Get_V1

Получение роли по идентификатору.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Application	application	True	string	Уникальный идентификатор приложения.
Role	role_id	True	string	Уникальный идентификатор роли.

Возвращаемое значение

Тело: RoleV1

Получение свойств модуля

Идентификатор операции:: Devices_GetModuleProperties_V1

Получение всех значений свойств модуля.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Application	application	True	string	Уникальный идентификатор приложения.
Идентификатор устройства	device_id	True	string	Уникальный идентификатор устройства.
Модуль устройства	module	True	string	Имя модуля устройства.
Шаблон устройства	template		string	Определение шаблона устройства для устройства.

Возвращаемое значение

Выходные данные этой операции являются динамическими.

Получение свойств облака устройства (не рекомендуется)

Идентификатор операции:: Devices_GetCloudProperties

Получение всех значений облачных свойств устройства по идентификатору устройства (не рекомендуется).

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Application	application	True	string	Уникальный идентификатор приложения.
Идентификатор устройства	device_id	True	string	Уникальный идентификатор устройства.
Идентификатор шаблона устройства	instanceOf		string	Определение шаблона устройства для устройства.

Возвращаемое значение

Выходные данные этой операции являются динамическими.

Получение свойств устройства

Идентификатор операции:: Devices_GetProperties_V1

Получение всех значений свойств устройства по идентификатору устройства.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Application	application	True	string	Уникальный идентификатор приложения.
Идентификатор устройства	device_id	True	string	Уникальный идентификатор устройства.
Шаблон устройства	template		string	Определение шаблона устройства для устройства.

Возвращаемое значение

Выходные данные этой операции являются динамическими.

Получение свойств устройства (не рекомендуется)

Идентификатор операции:: Devices_GetProperties

Получение всех значений свойств устройства по идентификатору устройства (не рекомендуется).

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Application	application	True	string	Уникальный идентификатор приложения.
Идентификатор устройства	device_id	True	string	Уникальный идентификатор устройства.
Идентификатор шаблона устройства	instanceOf		string	Определение шаблона устройства для устройства.

Возвращаемое значение

Выходные данные этой операции являются динамическими.

Получение связи устройства

Идентификатор операции:: DeviceRelationships_Get

Получение сведений о существующей связи устройства по идентификатору устройства и идентификатору связи.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Application	application	True	string	Уникальный идентификатор приложения.
Идентификатор устройства	device_id	True	string	Уникальный идентификатор устройства.
Идентификатор связи	relationship_id	True	string	Уникальный идентификатор связи устройства.

Возвращаемое значение

Тело: DeviceRelationshipStatic

Получение состояния устройства

Идентификатор операции:: Jobs_GetDevices

Получение списка состояний отдельных устройств по идентификатору задания.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Application	application	True	string	Уникальный идентификатор приложения.
Идентификатор задания	job_id	True	string	Уникальный идентификатор задания.

Возвращаемое значение

Страницы результатов состояния устройства задания.

Тело: JobDeviceStatusCollection

Получение устройств по идентификатору группы устройств

Идентификатор операции:: DeviceGroups_GetDevices

Получение списка устройств в группе устройств в приложении.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Application	application	True	string	Уникальный идентификатор приложения.
Идентификатор группы устройств	device_group_id	True	string	Уникальный идентификатор группы устройств.

Возвращаемое значение

Страницные результаты устройств, принадлежащих группе устройств.

Тело: DeviceGroupDeviceCollection

Получение устройства по его идентификатору

Идентификатор операции:: Devices_Get_V1

Получение сведений о существующем устройстве по идентификатору устройства.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Application	application	True	string	Уникальный идентификатор приложения.
Идентификатор устройства	device_id	True	string	Уникальный идентификатор устройства.

Возвращаемое значение

Тело: DeviceV1

Получение устройства по идентификатору (не рекомендуется)

Идентификатор операции:: Devices_Get

Получение сведений о существующем устройстве по идентификатору устройства (не рекомендуется).

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Application	application	True	string	Уникальный идентификатор приложения.
Идентификатор устройства	device_id	True	string	Уникальный идентификатор устройства.

Возвращаемое значение

Тело: Device

получить шаблон устройства по идентификатору;

Идентификатор операции:: DeviceTemplates_Get_V1

Получение сведений о существующем шаблоне устройства по идентификатору.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Application	application	True	string	Уникальный идентификатор приложения.
Template	template_id	True	string	Уникальный идентификатор шаблона.

Возвращаемое значение

Тело: DeviceTemplateV1

Создание группы устройств

Идентификатор операции:: DeviceGroups_Set

Создайте или обновите группу устройств.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Application	application	True	string	Уникальный идентификатор приложения.
Идентификатор группы устройств	device_group_id	True	string	Уникальный идентификатор группы устройств.
Идентификатор группы устройств	id		string	Уникальный идентификатор группы устройств.
Отображаемое имя	displayName	True	string	Отображаемое имя группы устройств.
Filter	filter	True	string	Запрос, определяющий, какие устройства должны находиться в этой группе.
Description	description		string	Краткая сводка по группе устройств.
ЭТаг	etag		string	ETag используется для предотвращения конфликтов в обновлениях группы устройств.
Organizations	organizations		array of string	Список организаций группы устройств, поддерживается только одна организация сегодня, несколько организаций будут поддерживаться в ближайшее время.

Возвращаемое значение

Определение группы устройств.

Тело: DeviceGroup

Создание задания

Идентификатор операции:: Jobs_Set

Создайте и выполните новое задание с помощью его определения задания.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Application	application	True	string	Уникальный идентификатор приложения.
Идентификатор задания	job_id	True	string	Уникальный идентификатор задания.
Тип задания	job_type		string	Тип задания.
Тело	body	True	dynamic	Текст создания задания.

Возвращаемое значение

Выходные данные этой операции являются динамическими.

Создание запланированного задания

Идентификатор операции:: ScheduledJobs_Set

Создайте и выполните новое запланированное задание с помощью определения задания.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Application	application	True	string	Уникальный идентификатор приложения.
Идентификатор запланированного задания	scheduled_job_id	True	string	Уникальный идентификатор запланированного задания.
Тип задания	job_type		string	Тип задания.
Тип окончания расписания	scheduled_job_end_type		string	Как должно завершиться запланированное задание (не применяется к миграциям шаблонов устройств).
Тело	body	True	dynamic	Текст создания запланированного задания.

Возвращаемое значение

Выходные данные этой операции являются динамическими.

Создание или обновление устройства

Идентификатор операции:: Devices_Set_V2

Создайте устройство или обновите существующее по идентификатору устройства.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Application	application	True	string	Уникальный идентификатор приложения.
Идентификатор устройства	device_id	True	string	Уникальный идентификатор устройства.
Идентификатор устройства	id		string	Уникальный идентификатор устройства.
Имя устройства	displayName		string	Отображаемое имя устройства.
Шаблон устройства	template		string	Определение шаблона устройства для устройства.
Симулированный	simulated		boolean	Имитируется ли устройство.
Включен	enabled		boolean	Включена ли подключение устройства к IoT Central.
Organizations	organizations		array of string	Список организаций устройства, поддерживается только одна организация сегодня, несколько организаций будут поддерживаться в ближайшее время.
Обеспечено	provisioned		boolean	Выделены ли ресурсы для устройства.

Возвращаемое значение

Тело: DeviceV2

Создание или обновление устройства (не рекомендуется)

Идентификатор операции:: Devices_Set_V1

Создайте устройство или обновите существующее по идентификатору устройства. (не рекомендуется)

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Application	application	True	string	Уникальный идентификатор приложения.
Идентификатор устройства	device_id	True	string	Уникальный идентификатор устройства.
Идентификатор устройства	id		string	Уникальный идентификатор устройства.
Имя устройства	displayName		string	Отображаемое имя устройства.
Шаблон устройства	template		string	Определение шаблона устройства для устройства.
Симулированный	simulated		boolean	Имитируется ли устройство.
Включен	enabled		boolean	Включена ли подключение устройства к IoT Central.
Обеспечено	provisioned		boolean	Выделены ли ресурсы для устройства.

Возвращаемое значение

Тело: DeviceV1

Создание или обновление устройства (не рекомендуется)

Идентификатор операции:: Devices_Set

Создайте устройство или обновите существующее по идентификатору устройства (не рекомендуется).

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Application	application	True	string	Уникальный идентификатор приложения.
Идентификатор устройства	device_id	True	string	Уникальный идентификатор устройства.
Идентификатор устройства	id		string	Уникальный идентификатор устройства.
Имя устройства	displayName		string	Отображаемое имя устройства.
Шаблон устройства	instanceOf		string	Определение шаблона устройства для устройства.
Симулированный	simulated		boolean	Имитируется ли устройство.
Утверждено	approved		boolean	Утверждено ли устройство для подключения к IoT Central.
Обеспечено	provisioned		boolean	Выделены ли ресурсы для устройства.

Возвращаемое значение

Тело: Device

Создание организации

Идентификатор операции:: Organizations_Set

Создание организации.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Application	application	True	string	Уникальный идентификатор приложения.
Идентификатор организации	organization_id	True	string	Уникальный идентификатор организации.
Идентификатор организации	id		string	Уникальный идентификатор организации.
Название организации	displayName		string	Отображаемое имя организации.
Parent	parent		string	Отображаемое имя родительской организации.

Возвращаемое значение

Тело: Organization

Создание пользователя

Идентификатор операции:: Users_Create_V1

Создание пользователя в приложении

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Application	application	True	string	Уникальный идентификатор приложения.
User	user_id	True	string	Уникальный идентификатор пользователя.
Тип пользователя	user_type		string	Тип пользователя.
Тело	body	True	dynamic	Текст создания пользователя.

Возвращаемое значение

Выходные данные этой операции являются динамическими.

Создание связи устройства

Идентификатор операции:: DeviceRelationships_Set

Создайте связь устройства между данным устройством и новым устройством с идентификатором устройства и идентификатором связи.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Application	application	True	string	Уникальный идентификатор приложения.
Идентификатор связи	relationship_id	True	string	Уникальный идентификатор связи устройства.
Идентификатор устройства	device_id	True	string	Уникальный идентификатор устройства.
Идентификатор связи устройства	id		string	Уникальный идентификатор связи устройства.
Идентификатор целевого объекта связи устройства	target	True	string	Идентификатор устройства источника (дочернего) устройства.

Возвращаемое значение

Тело: DeviceRelationshipStatic

Список заданий

Идентификатор операции:: Jobs_List

Получение списка заданий в приложении.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Application	application	True	string	Уникальный идентификатор приложения.

Возвращаемое значение

Страницы результатов заданий.

Тело: JobCollection

Список связей

Идентификатор операции:: DeviceRelationships_List

Вывод списка всех связей на основе идентификатора устройства.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Application	application	True	string	Уникальный идентификатор приложения.
Идентификатор устройства	device_id	True	string	Уникальный идентификатор устройства.

Возвращаемое значение

Тело: DeviceRelationshipCollection

Список устройств

Идентификатор операции:: Devices_List_V1

Получение списка устройств в приложении.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Application	application	True	string	Уникальный идентификатор приложения.

Возвращаемое значение

Тело: DeviceCollectionV1

Удаление группы устройств

Идентификатор операции:: DeviceGroups_Remove

Удаление существующей группы устройств по идентификатору

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Application	application	True	string	Уникальный идентификатор приложения.
Идентификатор группы устройств	device_group_id	True	string	Уникальный идентификатор группы устройств.

Удаление запланированного задания

Идентификатор операции:: ScheduledJobs_Remove

Удалите существующее запланированное задание по идентификатору.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Application	application	True	string	Уникальный идентификатор приложения.
Идентификатор запланированного задания	scheduled_job_id	True	string	Уникальный идентификатор запланированного задания.

Удаление организации

Идентификатор операции:: Organizations_Remove

Удаление существующей организации по идентификатору

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Application	application	True	string	Уникальный идентификатор приложения.
Идентификатор организации	organization_id	True	string	Уникальный идентификатор организации.

Удаление пользователя

Идентификатор операции:: Users_Remove_V1

Удаление пользователя

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Application	application	True	string	Уникальный идентификатор приложения.
User	user_id	True	string	Уникальный идентификатор пользователя.

Удаление связи устройства

Идентификатор операции:: DeviceRelationships_Remove

Удаление существующей связи устройства по идентификатору устройства и идентификатору связи.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Application	application	True	string	Уникальный идентификатор приложения.
Идентификатор устройства	device_id	True	string	Уникальный идентификатор устройства.
Идентификатор связи	relationship_id	True	string	Уникальный идентификатор связи устройства.

Удаление устройства

Идентификатор операции:: Devices_Remove_V1

Удалите существующее устройство по идентификатору устройства.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Application	application	True	string	Уникальный идентификатор приложения.
Идентификатор устройства	device_id	True	string	Уникальный идентификатор устройства.

Удаление устройства (не рекомендуется)

Идентификатор операции:: Devices_Remove

Удалите существующее устройство по идентификатору устройства (не рекомендуется).

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Application	application	True	string	Уникальный идентификатор приложения.
Идентификатор устройства	device_id	True	string	Уникальный идентификатор устройства.

удалить шаблон устройства;

Идентификатор операции:: DeviceTemplates_Remove_V1

Удалите существующий шаблон устройства по идентификатору.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Application	application	True	string	Уникальный идентификатор приложения.
Template	template_id	True	string	Уникальный идентификатор шаблона.

Триггеры

При запуске правила

Создайте действие, которое активирует при запуске правила в IoT Central.

При запуске правила

Идентификатор операции:: Workflow_CreateTrigger

Создайте действие, которое активирует при запуске правила в IoT Central.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Application	application	True	string	Уникальный идентификатор приложения.
Идентификатор триггера рабочего процесса	id		string	Уникальный идентификатор триггера рабочего процесса.
Правило	rule	True	string	Уникальный идентификатор правила, привязанного к триггеру рабочего процесса.

Возвращаемое значение

Выходные данные этой операции являются динамическими.

Определения

Device

Имя	Путь	Тип	Описание
Идентификатор устройства	id	string	Уникальный идентификатор устройства.
Имя устройства	displayName	string	Отображаемое имя устройства.
Шаблон устройства	instanceOf	string	Определение шаблона устройства для устройства.
Симулированный	simulated	boolean	Имитируется ли устройство.
Утверждено	approved	boolean	Утверждено ли устройство для подключения к IoT Central.
Обеспечено	provisioned	boolean	Выделены ли ресурсы для устройства.

DeviceV1

Имя	Путь	Тип	Описание
Идентификатор устройства	id	string	Уникальный идентификатор устройства.
Имя устройства	displayName	string	Отображаемое имя устройства.
Шаблон устройства	template	string	Определение шаблона устройства для устройства.
Симулированный	simulated	boolean	Имитируется ли устройство.
Включен	enabled	boolean	Включена ли подключение устройства к IoT Central.
Обеспечено	provisioned	boolean	Выделены ли ресурсы для устройства.

DeviceV2

Имя	Путь	Тип	Описание
Идентификатор устройства	id	string	Уникальный идентификатор устройства.
Имя устройства	displayName	string	Отображаемое имя устройства.
Шаблон устройства	template	string	Определение шаблона устройства для устройства.
Симулированный	simulated	boolean	Имитируется ли устройство.
Включен	enabled	boolean	Включена ли подключение устройства к IoT Central.
Organizations	organizations	array of string	Список организаций устройства, поддерживается только одна организация сегодня, несколько организаций будут поддерживаться в ближайшее время.
Обеспечено	provisioned	boolean	Выделены ли ресурсы для устройства.

DeviceCollectionV1

Имя	Путь	Тип	Описание
value	value	array of DeviceV1	Коллекция устройств.
nextLink	nextLink	string	URL-адрес для получения следующей страницы устройств.

DeviceGroup

Определение группы устройств.

Имя	Путь	Тип	Описание
Идентификатор группы устройств	id	string	Уникальный идентификатор группы устройств.
Отображаемое имя	displayName	string	Отображаемое имя группы устройств.
Filter	filter	string	Запрос, определяющий, какие устройства должны находиться в этой группе.
Description	description	string	Краткая сводка по группе устройств.
ЭТаг	etag	string	ETag используется для предотвращения конфликтов в обновлениях группы устройств.
Organizations	organizations	array of string	Список организаций группы устройств, поддерживается только одна организация сегодня, несколько организаций будут поддерживаться в ближайшее время.

DeviceGroupCollection

Страницные результаты групп устройств.

Имя	Путь	Тип	Описание
Идентификатор группы устройств	value	array of DeviceGroup	Коллекция групп устройств.
nextLink	nextLink	string	URL-адрес для получения следующей страницы групп устройств.

DeviceGroupDeviceCollection

Страницные результаты устройств, принадлежащих группе устройств.

Имя	Путь	Тип	Описание
value	value	array of DeviceV1	Коллекция устройств, принадлежащих группе устройств.
nextLink	nextLink	string	URL-адрес для получения следующей страницы устройств в группе.

DeviceRelationshipStatic

Имя	Путь	Тип	Описание
Идентификатор связи устройства	id	string	Уникальный идентификатор связи устройства.
Идентификатор источника связи устройства	source	string	Идентификатор устройства исходного (родительского) устройства.
Идентификатор целевого объекта связи устройства	target	string	Идентификатор устройства источника (дочернего) устройства.

DeviceRelationshipCollection

Имя	Путь	Тип	Описание
value	value	array of DeviceRelationshipStatic	Коллекция связей устройств.
nextLink	nextLink	string	URL-адрес для получения следующей страницы связей устройства.

DeviceTemplateV1

Имя	Путь	Тип	Описание
Идентификатор шаблона устройства	@id	string	Уникальный идентификатор шаблона устройства.
Типы шаблонов устройств	@type	array of string	Типы JSON-LD этого шаблона устройства.
Имя шаблона устройства	displayName	string	Отображаемое имя шаблона устройства.
Описание шаблона устройства	description	string	Подробное описание шаблона устройства.
Модель возможностей шаблона устройства	capabilityModel		Модель возможностей, используемая этим шаблоном устройства.

DeviceTemplateCollectionV1

Имя	Путь	Тип	Описание
value	value	array of DeviceTemplateV1	Коллекция шаблонов устройств.
nextLink	nextLink	string	URL-адрес для получения следующей страницы шаблонов устройств.

JobDeviceStatus

Определение состояния устройства задания.

Имя	Путь	Тип	Описание
Идентификатор устройства	id	string	Идентификатор устройства, состояние задания которого предоставляется.
Состояние устройства	status	string	Указывает, запускается ли задание, выполняется и т. д. для данного устройства.

JobDeviceStatusCollection

Страницы результатов состояния устройства задания.

Имя	Путь	Тип	Описание
value	value	array of JobDeviceStatus	Коллекция состояний устройства задания.
nextLink	nextLink	string	URL-адрес для получения следующей страницы состояния устройства задания.

JobBatch

Определение пакетной службы задания.

Имя	Путь	Тип	Описание
Тип пакета	type	string	Выполняется ли пакетная обработка на указанном количестве устройств или в процентах от общего числа устройств.
Значение пакетной службы	value	number	Число или процент устройств, на которых выполняется пакетная обработка.

JobCancellationThreshold

Определение порогового значения отмены задания.

Имя	Путь	Тип	Описание
Тип порогового значения отмены	type	string	Указывает, соответствует ли пороговое значение отмены заданному количеству устройств или проценту от общего числа устройств.
Пороговое значение отмены	value	number	Число или процент устройств, на которых применяется порог отмены.
Пакет порогового значения отмены	batch	boolean	Применяется ли порог отмены для каждого пакета или к общему заданию.

JobStatic

Определение задания.

Имя	Путь	Тип	Описание
Идентификатор задания	id	string	Уникальный идентификатор задания.
Отображаемое имя	displayName	string	Отображаемое имя задания.
Description	description	string	Подробное описание задания.
Группа устройств	group	string	Идентификатор группы устройств, в которой выполняется задание.
партия	batch	JobBatch	Определение пакетной службы задания.
отменаThreshold	cancellationThreshold	JobCancellationThreshold	Определение порогового значения отмены задания.
Данные	data	array of object	Данные, связанные с операцией, выполняемой этим заданием. Все записи должны иметь одинаковый тип.
items	data	object
Organizations	organizations	array of string	Список организаций задания поддерживается только одной организацией сегодня, несколько организаций будут поддерживаться в ближайшее время.
Идентификатор запланированного задания	scheduledJobId	string	Идентификатор определения запланированного задания, создавшего это задание.

JobCollection

Страницы результатов заданий.

Имя	Путь	Тип	Описание
value	value	array of JobStatic	Коллекция заданий.
nextLink	nextLink	string	URL-адрес для получения следующей страницы заданий.

Организация

Имя	Путь	Тип	Описание
Идентификатор организации	id	string	Уникальный идентификатор организации.
Название организации	displayName	string	Отображаемое имя организации.
Parent	parent	string	Отображаемое имя родительской организации.

OrganizationCollection

Имя	Путь	Тип	Описание
value	value	array of Organization	Коллекция организаций.
nextLink	nextLink	string	URL-адрес для получения следующей страницы организаций.

RoleV1

Имя	Путь	Тип	Описание
id	id	string	Уникальный идентификатор роли.
отображаемое имя	displayName	string	Отображаемое имя роли.

RoleCollectionV1

Имя	Путь	Тип	Описание
value	value	array of RoleV1	Коллекция ролей.

ScheduledJobStatic

Определение запланированного задания.

Имя	Путь	Тип	Описание
ЭТаг	etag	string	ETag используется для предотвращения конфликтов в запланированных обновлениях заданий.
Идентификатор запланированного задания	id	string	Уникальный идентификатор запланированного задания.
Отображаемое имя	displayName	string	Отображаемое имя запланированного задания.
Description	description	string	Подробное описание запланированного задания.
Группа устройств	group	string	Идентификатор группы устройств, в которой выполняется задание.
партия	batch	JobBatch	Определение пакетной службы задания.
отменаThreshold	cancellationThreshold	JobCancellationThreshold	Определение порогового значения отмены задания.
Данные	data	array of object	Данные, связанные с операцией, выполняемой этим заданием. Все записи должны иметь одинаковый тип.
items	data	object
Organizations	organizations	array of string	Список организаций задания поддерживается только одной организацией сегодня, несколько организаций будут поддерживаться в ближайшее время.
Расписание	schedule	object	Расписание выполнения задания.
Включен	enabled	boolean	Включен ли запланированное задание.
Завершено	completed	boolean	Завершено ли запланированное задание.

ScheduledJobJobCollection

Страницные результаты определений заданий, принадлежащих запланированному заданию.

Имя	Путь	Тип	Описание
value	value	array of JobStatic	Коллекция заданий.
nextLink	nextLink	string	URL-адрес для получения следующей страницы заданий.

UserStaticV1

Имя	Путь	Тип	Описание
Идентификатор пользователя	id	string	Уникальный идентификатор пользователя.
Тип пользователя	type	string	Тип пользователя.
Роли	roles	array of RoleAssignmentV1	Список назначений ролей, указывающих разрешения для доступа к приложению.

UserCollectionV1

Имя	Путь	Тип	Описание
Users	value	array of UserStaticV1	Коллекция пользователей.

RoleAssignmentV1

Имя	Путь	Тип	Описание
Role	role	string	Идентификатор роли для назначения этой роли.