Devices - Get

Service:

IoT Central

API Version:

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	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 device by ID

Sample Request

HTTP

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

Sample Response

Status code:

200

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

定義

名前	説明
Device	デバイス定義。
Error	応答エラーの定義。
ErrorDetails	エラーの詳細情報。

Device

デバイス定義。

名前	型	説明
displayName	string	デバイスの表示名。
enabled	boolean	IoT Central へのデバイス接続が有効になっているかどうか。
etag	string	デバイスの更新で競合を防ぐために使用される ETag。
id	string	デバイスの一意の ID。
organizations	string[]	デバイスが含まれているorganization ID の一覧。現在サポートされているorganizationは 1 つだけです。複数の組織が間もなくサポートされます。
provisioned	boolean	デバイスにリソースが割り当てられているかどうか。
simulated	boolean	デバイスがシミュレートされるかどうか。
template	string	デバイスのデバイス テンプレート定義。

Error

応答エラーの定義。

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

ErrorDetails

エラーの詳細情報。

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