Devices - Get

Служба:

IoT Central

Версия API:

2022-07-31

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

GET https://{subdomain}.{baseDomain}/api/devices/{deviceId}?api-version=2022-07-31

Параметры URI

Имя	В	Обязательно	Тип	Описание
baseDomain	path	True	string	Базовый домен для всех запросов службы Azure IoT Central.
deviceId	path	True	string	Уникальный идентификатор устройства.
subdomain	path	True	string	Поддомен приложения.
api-version	query	True	string	Версия вызываемого API.

Ответы

Имя	Тип	Описание
200 OK	Device	Успешное завершение
Other Status Codes	Error	Ответ об ошибке, полученный от службы IoT Central. Заголовки x-ms-error-code: string

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

Get device by ID

Образец запроса

HTTP

GET https://appsubdomain.azureiotcentral.com/api/devices/CheckoutThermostat?api-version=2022-07-31

Пример ответа

Код состояния:

200

{
  "id": "CheckoutThermostat",
  "etag": "eyJoZWFkZXIiOiJcIjAyMDA4YzMyLTAwMDAtMGQwMC0wMDAwLTVkOTY4YjdhMDAwMFwiIn0",
  "displayName": "CheckoutThermostat",
  "template": "dtmi:contoso:testDeviceTemplate;1",
  "simulated": true,
  "provisioned": true,
  "enabled": true,
  "organizations": [
    "seattle"
  ]
}

Определения

Имя	Описание
Device	Определение устройства.
Error	Определение ошибки ответа.
ErrorDetails	Подробные сведения об ошибке.

Device

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

Имя	Тип	Описание
displayName	string	Отображаемое имя устройства.
enabled	boolean	Было ли включено подключение устройства к IoT Central.
etag	string	ETag используется для предотвращения конфликтов при обновлениях устройств.
id	string	Уникальный идентификатор устройства.
organizations	string[]	Список идентификаторов организаций, частью которыми является устройство. На сегодняшний день поддерживается только одна организация, в ближайшее время будет поддерживаться несколько организаций.
provisioned	boolean	Выделены ли ресурсы для устройства.
simulated	boolean	Смоделировано ли устройство.
template	string	Определение шаблона устройства.

Error

Определение ошибки ответа.

Имя	Тип	Описание
error	ErrorDetails	Сведения об ошибке для текущего запроса.

ErrorDetails

Подробные сведения об ошибке.

Имя	Тип	Описание
code	string	Код ошибки.
message	string	Сведения об сообщении об ошибке.
requestId	string	Идентификатор корреляции для текущего запроса.
time	string	Время сбоя запроса ошибки.