Devices - Get Properties

Service:

IoT Central

API Version:

2022-07-31

デバイスのプロパティを取得する
デバイス ID でデバイスのすべてのプロパティ値を取得します。

GET https://{subdomain}.{baseDomain}/api/devices/{deviceId}/properties?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	DeviceProperties	Success
Other Status Codes	Error	IoT Central サービスから受信したエラー応答。 Headers x-ms-error-code: string

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

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

Scopes

名前	説明
user_impersonation	ユーザー アカウントの借用

例

Get properties

Sample Request

HTTP

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

Sample Response

Status code:

200

{
  "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

応答エラーの定義。

名前	型	説明
error	ErrorDetails	現在の要求のエラーの詳細。

ErrorDetails

エラーの詳細情報。

名前	型	説明
code	string	エラー コード。
message	string	エラー メッセージの詳細。
requestId	string	現在の要求の関連付け ID。
time	string	エラー要求が失敗した時刻。