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

Devices - Get

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

GET https://{subdomain}.{baseDomain}/api/devices/{deviceId}?api-version=2022-06-30-preview

URI 参数

Name In Required Type Description
baseDomain
path True
  • string

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

deviceId
path True
  • string

设备的唯一 ID。

subdomain
path True
  • string

应用程序子域。

api-version
query True
  • string

要调用的 API 的版本。

响应

Name Type Description
200 OK

成功

Other Status Codes

从 IoT Central 服务收到的错误响应。

Headers

  • x-ms-error-code: string

安全性

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation 模拟用户帐户

示例

Get device by ID

Sample Request

GET https://appsubdomain.azureiotcentral.com/api/devices/CheckoutThermostat?api-version=2022-06-30-preview

Sample Response

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

定义

Device

设备定义。

Error

响应错误定义。

ErrorDetails

错误的详细信息。

Device

设备定义。

Name Type Description
displayName
  • string

设备的显示名称。

enabled
  • boolean

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

etag
  • string

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

id
  • string

设备的唯一 ID。

organizations
  • string[]

设备所属的组织 ID 列表,目前仅支持一个组织,很快会支持多个组织。

provisioned
  • boolean

是否为设备分配了资源。

simulated
  • boolean

设备是否模拟。

template
  • string

设备的设备模板定义。

Error

响应错误定义。

Name Type Description
error

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

ErrorDetails

错误的详细信息。

Name Type Description
code
  • string

错误代码。

message
  • string

错误消息详细信息。

requestId
  • string

当前请求的关联 ID。

time
  • string

错误请求失败的时间。