共用方式為


azure-iothub package

類別

Client

IoT 中樞服務用戶端可用來透過 Azure IoT 中樞與裝置通訊。 它可讓 SDK 使用者:

  • 將雲端到裝置(也稱為命令)傳送至裝置:命令會在IoT中樞上排入佇列,且只有在裝置連線時才會以異步方式傳遞。 每個裝置只能將 50 個命令排入佇列。
  • 在裝置上叫用直接方法(只有在裝置目前已連線時才有效:這是與裝置通訊的同步方式)
  • 接聽裝置針對先前命令傳送的意見反應訊息。
  • 接聽來自裝置的檔案上傳通知。

用戶應該藉由呼叫其中一個 Factory 方法,從ConnectionString 或從SharedAccessSignature 建立 IoT 中樞服務用戶端,以建立新的 Client 實例。

Device

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

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

JobClient

提供在IoT中樞實例上建立、更新、監視和取消長時間執行的作業,以及查詢現有作業的方法。 Azure IoT 中樞中的作業 API 允許在多個裝置上排程直接方法呼叫和對應項更新。

SDK 使用者應該使用處理站方法來建立 JobClient 實體,fromConnectionString(string)fromSharedAccessSignature(string)

Registry

登錄類別提供IoT中樞裝置身分識別服務的存取權。 SDK 的用戶應該使用其中一個 Factory 方法具現化此類別:fromConnectionString,或從SharedAccessSignature

用於裝置身分識別登錄作業的通訊協定是 HTTPS。

Amqp

服務用戶端所使用的傳輸類別 透過安全 (TLS) 套接字使用AMQP通訊協定連線到 Azure IoT 中樞。 這個類別不應該直接使用,而是傳遞至其中一個 Client Factory 方法:fromConnectionStringfromSharedAccessSignature

AmqpWs

服務用戶端所使用的傳輸類別 透過安全的Websocket使用AMQP通訊協定連線到 Azure IoT 中樞。 這個類別不應該直接使用,而是傳遞至其中一個 Client Factory 方法:fromConnectionStringfromSharedAccessSignature

DigitalTwinClient
IoTHubTokenCredentials

根據傳遞至建構函式的連接字串,建立共用存取簽章。 SDK 的通訊協定層會使用此類別,將驗證標頭新增至每個要求。

Twin

裝置對應項是說明 Azure IoT 中樞所儲存之裝置狀態的檔,即使裝置已離線,仍可供使用。 其建置約3個區段:

  • 標籤:金鑰/值群組只能從服務端存取
  • 所需屬性:由服務更新,並由裝置接收
  • 報告屬性:由裝置更新,並由服務接收。

請注意,雖然有可能,但想要和報告的屬性不需要相符,而且如果需要,同步這兩個集合的邏輯會留給SDK的使用者。

如需詳細資訊,請參閱 瞭解裝置對應項

取得特定裝置 Twin 的建議方法是使用 getTwin(string, HttpResponseCallback<Twin>) 方法。

介面

ServiceReceiver
Transport
TransportConfigOptions
Authentication
Capabilities
X509Thumbprints
BulkRegistryOperationResult
DeviceDescription
DeviceRegistryOperationError
JobStatus
QueryDescription
RegistryStatistics
TransportConfig
Configuration

Configuration 物件代表單一裝置的組態,也可以代表部署,可根據 targetCondition 套用為裝置的組態。

ConfigurationContent
ConfigurationMetrics
DeviceMethodParams

描述可用於直接方法的參數(也稱為裝置方法)

Module

類型別名

TransportCtor
ConnectionState
DeviceStatus
JobCallback
BulkRegistryOperationType
JobCallback
ResponseCallback