azure-iothub package
類別
Client |
IoT 中樞服務用戶端可用來透過 Azure IoT 中樞與裝置通訊。 它可讓 SDK 使用者:
使用者應該 Client 藉由呼叫其中一個Factory 方法,fromConnectionString或fromSharedAccessSignature來建立新的實例,以建立IoT 中樞服務用戶端。 |
Device |
建立裝置的標記法,以搭配裝置身分 識別登錄 API 使用。 這個類別已被取代 ,因為 裝置身 分識別登錄可以直接與包含裝置部分描述的 JSON 物件搭配使用,不一定是完整的物件。 在這一開始,這個類別在屬性名稱上 |
JobClient |
提供在IoT 中樞實例上建立、更新、監視和取消長時間執行作業的方法,以及查詢現有的作業。 Azure IoT 中樞中的作業 API 允許在多個裝置上排程直接方法呼叫和對應項更新。 SDK 使用者預期會使用 Factory 方法 fromConnectionString(string) 和 fromSharedAccessSignature(string) 來建立 JobClient 實例。 |
Registry |
登錄類別可讓您存取IoT 中樞裝置身分識別服務。 SDK 的使用者應該使用其中一個 Factory 方法具現化此類別: fromConnectionString 或 fromSharedAccessSignature。 用於裝置身分識別登錄作業的通訊協定是 HTTPS。 |
Amqp |
服務用戶端用來透過安全 (TLS) 通訊端使用 AMQP 通訊協定連線到 Azure IoT 中樞的傳輸類別。 此類別不應該直接使用,而是傳遞至其中 Client 一個 Factory 方法: fromConnectionString 或 fromSharedAccessSignature。 |
AmqpWs |
服務用戶端用來透過安全 Websocket 的 AMQP 通訊協定連線到 Azure IoT 中樞的傳輸類別。 此類別不應該直接使用,而是傳遞至其中 Client 一個 Factory 方法: fromConnectionString 或 fromSharedAccessSignature。 |
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 |