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

Devices - Get Component Properties

获取特定组件的设备属性

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

URI 参数

Name In Required Type Description
baseDomain
path True
  • string

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

componentName
path True
  • string

设备组件的名称。

deviceId
path True
  • string

设备的唯一 ID。

subdomain
path True
  • string

应用程序子域。

api-version
query True
  • string

要调用的 API 的版本。

unmodeled
query
  • boolean

用于支持未建模属性的查询参数。

响应

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 on components

Sample Request

GET https://appsubdomain.azureiotcentral.com/api/devices/mx1/components/settings/properties?api-version=2022-06-30-preview

Sample Response

{
  "fanSpeed": 35,
  "voltage": 5,
  "current": 2,
  "irSwitch": true,
  "$metadata": {
    "fanSpeed": {
      "desiredValue": 35,
      "ackCode": 200,
      "ackVersion": 2,
      "ackDescription": "Processed"
    },
    "voltage": {
      "desiredValue": 5,
      "ackCode": 200,
      "ackVersion": 2,
      "ackDescription": "Processed"
    },
    "current": {
      "desiredValue": 2,
      "ackCode": 200,
      "ackVersion": 2,
      "ackDescription": "Processed"
    },
    "irSwitch": {
      "desiredValue": true,
      "ackCode": 200,
      "ackVersion": 2,
      "ackDescription": "Processed"
    }
  }
}

定义

Error

响应错误定义。

ErrorDetails

错误的详细信息。

Error

响应错误定义。

Name Type Description
error

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

ErrorDetails

错误的详细信息。

Name Type Description
code
  • string

错误代码。

message
  • string

错误消息详细信息。

requestId
  • string

当前请求的相关 ID。

time
  • string

错误请求失败的时间。