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

Devices - Get Properties

获取设备属性
按设备 ID 获取设备的所有属性值。

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

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
  • DeviceProperties

成功

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 properties

Sample Request

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

Sample Response

{
  "deviceinfo": {
    "manufacturer": "manufacturer",
    "$metadata": {
      "manufacturer": {
        "lastUpdateTime": "2020-07-21T19:06:50.9718608Z"
      },
      "model": {
        "lastUpdateTime": "2020-07-21T19:06:50.9718608Z"
      },
      "swVersion": {
        "lastUpdateTime": "2020-07-21T19:06:50.9718608Z"
      }
    },
    "model": "model",
    "swVersion": "swVersion"
  },
  "settings": {
    "fanSpeed": 12.5,
    "$metadata": {
      "fanSpeed": {
        "desiredValue": 30,
        "desiredVersion": 2,
        "lastUpdateTime": "2020-07-21T19:06:50.9718608Z"
      }
    }
  }
}

定义

Error

响应错误定义。

ErrorDetails

错误的详细信息。

Error

响应错误定义。

Name Type Description
error

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

ErrorDetails

错误的详细信息。

Name Type Description
code
  • string

错误代码。

message
  • string

错误消息详细信息。

requestId
  • string

当前请求的关联 ID。

time
  • string

错误请求失败的时间。