Device class
警告
この API は非推奨になりました。
デバイス ID レジストリ API で使用するデバイスの表現を作成します。
このクラスは、デバイス ID レジストリ が、デバイスの部分的な説明を含む JSON オブジェクトを直接操作できるため、 非推奨となりました。これは、必ずしも完全なオブジェクトであるとは限りません。 その上に、このクラスは最初に symmetricKey プロパティ名の入力ミスで出荷されました(キャメルケースではなくパスカルケースでした)。 SDK では、既存のコードを中断しないようにこのクラスを保持していますが、これは将来のメジャー バージョンの更新で削除される予定であり、お客様は代わりにプレーン JSON オブジェクトを使用する必要があります。
コンストラクター
| Device(any) | 新しい Device オブジェクトをインスタンス化します。 |
プロパティ
| authentication | このデバイスの認証に使用される対称キーが含まれています。 |
| capabilities | このデバイスの機能が含まれています。 |
| cloud |
デバイスに配信される待機中の c2d メッセージの数。 |
| connection |
デバイスが "接続済み" か "切断" か。 ただし、デバイス接続がタイムアウトし、IoT ハブで検出されていない可能性があるため、またはデバイスが接続に HTTPS を使用している場合は、このプロパティを使用して、デバイスが現在実際に接続されているかどうかを判断することはお勧めしません。 デバイス接続を監視する必要がある場合、推奨される方法は、ハブの 操作監視 機能を使用することです。 |
| connection |
最後に変更された時刻を表すタイムスタンプ |
| device |
Azure IoT Hub デバイス レジストリに存在する一意のデバイス識別子。 |
| etag | このデバイス ID の説明に割り当てられている弱いエンティティ タグ |
| generation |
同じ |
| last |
デバイスが最後に認証、メッセージを送信、またはメッセージを受信した時刻を表すタイムスタンプ。 |
| status | 'enabled' (接続が許可されているデバイス、メッセージの送受信が可能) または '無効' です。 |
| status |
デバイスが無効な場合に設定される 128 文字の文字列。 |
| status |
最後に変更された時刻を表すタイムスタンプ |
コンストラクターの詳細
Device(any)
新しい Device オブジェクトをインスタンス化します。
new Device(jsonData?: any)パラメーター
- jsonData
-
any
デバイスの省略可能な JSON 表現。オブジェクト内のプロパティにマップされます。 引数が指定されていない場合、デバイスのプロパティには既定値が割り当てられます。
プロパティの詳細
authentication
capabilities
cloudToDeviceMessageCount
デバイスに配信される待機中の c2d メッセージの数。
cloudToDeviceMessageCount?: stringプロパティ値
string
connectionState
デバイスが "接続済み" か "切断" か。 ただし、デバイス接続がタイムアウトし、IoT ハブで検出されていない可能性があるため、またはデバイスが接続に HTTPS を使用している場合は、このプロパティを使用して、デバイスが現在実際に接続されているかどうかを判断することはお勧めしません。 デバイス接続を監視する必要がある場合、推奨される方法は、ハブの 操作監視 機能を使用することです。
connectionState?: ConnectionStateプロパティ値
connectionStateUpdatedTime
最後に変更された時刻を表すタイムスタンプ connectionState。
connectionStateUpdatedTime?: stringプロパティ値
string
deviceId
Azure IoT Hub デバイス レジストリに存在する一意のデバイス識別子。
deviceId: stringプロパティ値
string
etag
このデバイス ID の説明に割り当てられている弱いエンティティ タグ
etag?: stringプロパティ値
string
generationId
同じ deviceId で削除または再作成されたデバイスのあいまいさを解消するために使用されます
generationId?: stringプロパティ値
string
lastActivityTime
デバイスが最後に認証、メッセージを送信、またはメッセージを受信した時刻を表すタイムスタンプ。
lastActivityTime?: stringプロパティ値
string
status
statusReason
デバイスが無効な場合に設定される 128 文字の文字列。
statusReason?: stringプロパティ値
string
statusUpdatedTime
最後に変更された時刻を表すタイムスタンプ status。
statusUpdatedTime?: stringプロパティ値
string