通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Devices - Get

服务:
IoT Central
API 版本:
2022-07-31

按 ID 获取设备
按设备 ID 获取有关现有设备的详细信息。

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

URI 参数

名称 在 必需 类型 说明
baseDomain
 path True

string

所有 Azure IoT Central 服务请求的基域。
deviceId
 path True

string

设备的唯一 ID。
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

Azure Active Directory OAuth2 流

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

Get device by ID

示例请求

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

Object

设备定义。

名称 类型 说明
displayName

string

设备的显示名称。
enabled

boolean

是否已启用到 IoT Central 的设备连接。
etag

string

用于防止设备更新冲突的 ETag。
id

string

设备的唯一 ID。
organizations

string[]

设备所属的组织 ID 列表，目前仅支持一个组织，不久将支持多个组织。
provisioned

boolean

是否已为设备分配资源。
simulated

boolean

设备是否模拟。
template

string

设备的设备模板定义。

Error

Object

响应错误定义。

名称 类型 说明
error

ErrorDetails

当前请求的错误详细信息。

ErrorDetails

Object

错误的详细信息。

名称 类型 说明
code

string

错误代码。
message

string

错误消息详细信息。
requestId

string

当前请求的相关 ID。
time

string (date-time-rfc1123)

错误请求失败的时间。