Devices - Get

Service:
IoT Central
API バージョン:
2022-07-31

ID でデバイスを取得する
デバイス ID を使用して、既存のデバイスに関する詳細を取得します。

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

URI パラメーター

Name / 必須 型 説明
baseDomain
 path True

string

すべての Azure IoT Central サービス要求のベース ドメイン。
deviceId
 path True

string

デバイスの一意の ID。
subdomain
 path True

string

アプリケーション サブドメイン。
api-version
 query True

string

呼び出される API のバージョン。

応答

Name 型 説明
200 OK

Device

成功
Other Status Codes

Error

IoT Central サービスから受信したエラー応答。

ヘッダー

x-ms-error-code: string

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

Name 説明
user_impersonation ユーザー アカウントを偽装する

例

Get device by ID

要求のサンプル

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

応答のサンプル

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

定義

Name 説明
Device

デバイス定義。
Error

応答エラーの定義。
ErrorDetails

エラーの詳細情報。

Device

Object

デバイス定義。

Name 型 説明
displayName

string

デバイスの表示名。
enabled

boolean

IoT Central へのデバイス接続が有効になっているかどうか。
etag

string

デバイス更新プログラムの競合を防ぐために使用される ETag。
id

string

デバイスの一意の ID。
organizations

string[]

デバイスが一部である組織 ID の一覧。現在サポートされている組織は 1 つだけです。複数の組織が間もなくサポートされます。
provisioned

boolean

リソースがデバイスに割り当てられているかどうか。
simulated

boolean

デバイスがシミュレートされるかどうか。
template

string

デバイスのデバイス テンプレート定義。

Error

Object

応答エラーの定義。

Name 型 説明
error

ErrorDetails

現在の要求のエラーの詳細。

ErrorDetails

Object

エラーの詳細情報。

Name 型 説明
code

string

エラー コード。
message

string

エラー メッセージの詳細。
requestId

string

現在の要求の関連付け ID。
time

string (date-time-rfc1123)

エラー要求が失敗した時刻。