共用方式為

Device class

  • 參考
套件:
azure-iothub

警告

此 API 現已淘汰。

建立裝置的表示法，以搭配 裝置身分識別登錄 API 使用。

此類別已被取代，因為 裝置身分識別登錄 可以直接使用包含裝置部分描述的 JSON 物件，而不一定是完整的物件。 除此之外，這個類別最初隨附於 symmetricKey 屬性名稱上的錯字（它是 pascal-cased，而不是駱駝大小寫）。 SDK 會保留此類別，以免中斷現有的程式代碼，但在未來的主要版本更新中將會移除此類別，而客戶應該改用純 JSON 物件。

建構函式

Device(any)

具現化新的 Device 物件。

屬性

authentication

包含用來驗證此裝置的對稱金鑰。
capabilities

包含此裝置的功能。
cloudToDeviceMessageCount

已傳遞至裝置的 c2d 訊息數目。
connectionState

裝置為「已連線」或「已中斷連線」。 不過，不建議使用此屬性來判斷裝置目前是否已實際連線，因為裝置連線可能已逾時，且IoT中樞可能未偵測到，或者裝置是否使用 HTTPS 進行連線。 如果您需要監視裝置連線，重新認可的方式是使用中樞的 作業監視 功能。
connectionStateUpdatedTime

時間戳，代表上次變更 connectionState 的時間。
deviceId

Azure IoT 中樞裝置登錄中存在的唯一裝置標識碼。
etag

指派給此裝置身分識別描述的弱式實體標籤
generationId

用來釐清已使用相同的 deviceId 刪除/重新建立的裝置
lastActivityTime

時間戳，代表裝置上次驗證、傳送訊息或收到訊息的時間。
status

「已啟用」（授權連線的裝置，可以傳送/接收訊息）或「已停用」。
statusReason

當裝置停用時，會設定 128 個字元的字串。
statusUpdatedTime

時間戳，代表上次變更 status 的時間。

建構函式詳細資料

Device(any)

具現化新的 Device 物件。

new Device(jsonData?: any)

參數

jsonData

any

裝置的選擇性 JSON 表示法，其會對應至 物件中的屬性。 如果未提供自變數，則會指派裝置屬性的預設值。

屬性詳細資料

authentication

包含用來驗證此裝置的對稱金鑰。

authentication?: Authentication

屬性值

Authentication

capabilities

包含此裝置的功能。

capabilities?: Capabilities

屬性值

Capabilities

cloudToDeviceMessageCount

已傳遞至裝置的 c2d 訊息數目。

cloudToDeviceMessageCount?: string

屬性值

string

connectionState

裝置為「已連線」或「已中斷連線」。 不過，不建議使用此屬性來判斷裝置目前是否已實際連線，因為裝置連線可能已逾時，且IoT中樞可能未偵測到，或者裝置是否使用 HTTPS 進行連線。 如果您需要監視裝置連線，重新認可的方式是使用中樞的 作業監視 功能。

connectionState?: ConnectionState

屬性值

ConnectionState

connectionStateUpdatedTime

時間戳，代表上次變更 connectionState 的時間。

connectionStateUpdatedTime?: string

屬性值

string

deviceId

Azure IoT 中樞裝置登錄中存在的唯一裝置標識碼。

deviceId: string

屬性值

string

etag

指派給此裝置身分識別描述的弱式實體標籤

etag?: string

屬性值

string

generationId

用來釐清已使用相同的 deviceId 刪除/重新建立的裝置

generationId?: string

屬性值

string

lastActivityTime

時間戳，代表裝置上次驗證、傳送訊息或收到訊息的時間。

lastActivityTime?: string

屬性值

string

status

「已啟用」（授權連線的裝置，可以傳送/接收訊息）或「已停用」。

status?: DeviceStatus

屬性值

DeviceStatus

statusReason

當裝置停用時，會設定 128 個字元的字串。

statusReason?: string

屬性值

string

statusUpdatedTime

時間戳，代表上次變更 status 的時間。

statusUpdatedTime?: string

屬性值

string