Share via


Device class

警告

この API は非推奨になりました。

デバイス ID レジストリ API で使用するデバイスの表現を作成します。

デバイス ID レジストリは、デバイスの部分的な説明を含む JSON オブジェクトを直接操作できるため、このクラスは非推奨です。完全なオブジェクトであるとは限りません。 その上に、このクラスは最初にプロパティ名の symmetricKey 入力ミスで出荷されました(キャメルケースではなくパスカルケースでした)。 SDK では、既存のコードを中断しないようにこのクラスを維持していますが、これは今後のメジャー バージョンの更新で削除され、お客様は代わりにプレーンな JSON オブジェクトを使用する必要があります。

コンストラクター

Device(any)

新しい Device オブジェクトのインスタンスを作成します。

プロパティ

authentication

このデバイスの認証に使用される対称キーが含まれています。

capabilities

このデバイスの機能が含まれています。

cloudToDeviceMessageCount

デバイスに配信されて待機している c2d メッセージの数。

connectionState

デバイスが "接続済み" か "切断" かに関係なく。 ただし、デバイス接続がタイムアウトし、IoT ハブで検出されていない可能性があるため、またはデバイスが接続に HTTPS を使用している場合は、このプロパティを使用して、デバイスが現在実際に接続されているかどうかを判断することはお勧めしません。 デバイス接続を監視する必要がある場合、再コミットされた方法は、ハブの 操作監視 機能を使用することです。

connectionStateUpdatedTime

最後に変更された時刻 connectionState を表すタイムスタンプ。

deviceId

Azure IoT Hub デバイス レジストリに存在する一意のデバイス識別子。

etag

このデバイス ID の説明に割り当てられた弱いエンティティ タグ

generationId

同じで削除または再作成されたデバイスを明確にするために使用されます deviceId

lastActivityTime

デバイスが最後に認証、メッセージを送信、またはメッセージを受信した時刻を表すタイムスタンプ。

status

'enabled' (接続が承認され、メッセージを送受信できるデバイス) または 'disabled' 。

statusReason

デバイスが無効になっている場合に設定される 128 文字の文字列。

statusUpdatedTime

最後に変更された時刻 status を表すタイムスタンプ。

コンストラクターの詳細

Device(any)

新しい Device オブジェクトのインスタンスを作成します。

new Device(jsonData?: any)

パラメーター

jsonData

any

デバイスの省略可能な JSON 表現。これは オブジェクト内のプロパティにマップされます。 引数が指定されていない場合、Device プロパティには既定値が割り当てられます。

プロパティの詳細

authentication

このデバイスの認証に使用される対称キーが含まれています。

authentication?: Authentication

プロパティ値

capabilities

このデバイスの機能が含まれています。

capabilities?: 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

'enabled' (接続が承認され、メッセージを送受信できるデバイス) または 'disabled' 。

status?: DeviceStatus

プロパティ値

statusReason

デバイスが無効になっている場合に設定される 128 文字の文字列。

statusReason?: string

プロパティ値

string

statusUpdatedTime

最後に変更された時刻 status を表すタイムスタンプ。

statusUpdatedTime?: string

プロパティ値

string