共用方式為

Device class

  • 參考
套件:
azure-iothub

警告

此 API 現已淘汰。

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

這個類別已被取代 ，因為 裝置身分識別登錄 可以直接使用包含裝置部分描述的 JSON 物件，不一定是完整物件。 在這一開始，這個類別在屬性名稱上 symmetricKey 隨附錯字， (它是 pascal 大小寫，而不是使用 camel 大小寫) 。 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