azure-iot-common package
類別
| Message |
物件 Message 用於裝置到雲端) (遙測和命令， (裝置間) 裝置與IoT 中樞服務之間的非同步傳訊。 它與傳輸無關，這表示它的運作方式與 AMQP、MQTT 和 HTTP 相同。 |
| ArgumentError |
引數無效時擲回的錯誤。 |
| ArgumentOutOfRangeError |
引數的值超出可接受範圍時擲回的錯誤。 |
| BadDeviceResponseError |
當裝置傳送不正確的回應給裝置方法呼叫時擲回的錯誤。 |
| CloudToDeviceDetachedError |
c2d 功能在傳輸層級停止運作時擲回的錯誤，要求用戶端重試啟動它。 |
| DeviceAlreadyExistsError |
當用於建立裝置的裝置識別碼已存在於裝置身分識別登錄中時擲回的錯誤。 |
| DeviceMaximumQueueDepthExceededError |
裝置訊息佇列已滿時擲回的錯誤。 |
| DeviceMessageLockLostError |
解決訊息失敗時擲回的錯誤，因為與訊息相關聯的鎖定權杖遺失。 |
| DeviceMethodsDetachedError |
裝置方法功能在傳輸層級停止運作時擲回的錯誤，要求用戶端重試啟動它。 |
| DeviceNotFoundError |
在 IoT 中樞 實例登錄中找不到裝置時擲回的錯誤。 |
| DeviceRegistrationFailedError |
DPS 註冊作業失敗時擲回的錯誤 |
| DeviceTimeoutError |
當裝置未及時處理方法呼叫時擲回的錯誤。 |
| FormatError |
當應該具有特定格式的字串未正確格式化時，擲回錯誤。 |
| GatewayTimeoutError |
IoT 中樞實例未及時處理裝置方法呼叫時擲回的錯誤。 |
| InternalServerError |
發生內部伺服器錯誤時擲回的錯誤。 您可能發現錯誤嗎？ |
| InvalidEtagError |
當指定的 eTag 格式不正確或過期時擲回的錯誤。 |
| InvalidOperationError |
嘗試作業但不允許時擲回錯誤。 |
| IotHubNotFoundError |
找不到 Azure IoT 中樞時擲回的錯誤。 |
| IotHubQuotaExceededError |
擲回 Azure IoT 中樞配額已超過的錯誤。 配額會定期重設，此作業必須等到該時間。 若要深入瞭解配額，請參閱Azure IoT 中樞配額和節流 |
| IoTHubSuspendedError |
暫停IoT 中樞時擲回的錯誤。 |
| JobNotFoundError |
找不到具有指定識別碼的作業時擲回的錯誤。 |
| MessageTooLargeError |
當傳送的訊息太大時擲回錯誤：大小上限為 256Kb。 |
| NotConnectedError |
當裝置中斷連線且無法完成作業時擲回的錯誤。 |
| NotImplementedError |
尚未實作功能但預留位置存在時擲回錯誤。 |
| OperationCancelledError |
取消本機或遠端) 的任何作業 (時擲回錯誤 |
| PreconditionFailedError |
當應該符合才能執行作業的條件時擲回錯誤。 |
| SecurityDeviceError |
低階安全性裝置/驅動程式失敗時擲回的錯誤。 |
| ServiceUnavailableError |
服務無法使用時擲回的錯誤。 應重試作業。 |
| ThrottlingError |
因為活動過多而節流IoT 中樞時擲回的錯誤。 若要深入瞭解配額，請參閱Azure IoT 中樞配額和節流 |
| TimeoutError |
發生逾時時擲回的錯誤 |
| TooManyDevicesError |
達到特定中樞上裝置數目上限時擲回的錯誤。 |
| TwinDetachedError |
當對應項功能在傳輸層級停止運作時擲回的錯誤，要求用戶端重試啟動它。 |
| TwinRequestError |
當對應項要求失敗並出現未知的錯誤碼時，所擲回的一般錯誤。 |
| UnauthorizedError |
連接參數錯誤且伺服器拒絕連線時擲回的錯誤。 |
| Connected |
成功連接傳輸時傳回的結果。 |
| Disconnected |
成功中斷傳輸時傳回的結果。 |
| MessageAbandoned |
成功放棄訊息時傳回的結果。 |
| MessageCompleted |
成功拒絕訊息時傳回的結果。 |
| MessageEnqueued |
成功排入佇列訊息時傳回的結果。 |
| MessageRejected |
成功拒絕訊息時傳回的結果。 |
| SharedAccessSignatureUpdated |
成功更新 SAS 權杖時傳回的結果。 |
| TransportConfigured |
成功設定傳輸時傳回的結果。 |
| ConnectionString |
描述可讓裝置或雲端應用程式連線到 Azure IoT 中樞的參數。 |
| ExponentialBackOffWithJitter |
實作具有抖動重試策略的指數輪詢。 計算下一個間隔的函式是下列 (x 是第 x 次重試) ：F (x) = min (Cmin+ (2^ (x-1) -1) * (C * (1 – Jd) C* (1-Ju) ) ，Cmax) |
| NoRetry |
封鎖任何重試暫訂的存根原則。 不會重試作業。 |
| RetryOperation |
實作重試作業的必要邏輯，例如連線、接收 C2D 訊息、傳送遙測、對應項更新等。 |
| SharedAccessSignature |
使用對稱金鑰 (而非 x509 憑證時，共用存取簽章權杖可用來驗證連線，) 來保護與 Azure IoT 中樞的連線。 |
介面
| AuthenticationProvider |
介面，必須由物件實作，這些物件用來提供認證給裝置用戶端用來向 Azure IoT 中樞實例進行驗證的傳輸。 |
| Receiver | |
| RetryPolicy |
描述重試原則物件的介面。 重試原則是由 2 件事所組成
這 2 個元件會隱藏在此介面中所述的 2 個方法呼叫後方。 |
| TransportConfig |
傳輸和 |
| X509 |
用來儲存 X509 憑證和金鑰的物件，以供傳輸使用。 這會直接傳遞至Node.js用來連接 TLS 通訊端的低階物件。 https://nodejs.org/api/tls.html#tls_tls_connect_options_callback |
類型別名
| BufferConvertible | |
| ResultWithHttpResponse | |
| Callback |
定義以兩個結果描述一般回呼的類型- 一個是 Error，另一個是結果值。 |
| DoubleValueCallback |
定義以兩個結果描述回呼的類型。 |
| ErrorCallback |
定義只描述錯誤結果值的回呼類型。 |
| HttpResponseCallback |
定義以三個結果描述回呼的類型-回應、原始 HTTP 回應和錯誤。 |
| NoErrorCallback |
定義以一個非錯誤結果值描述回呼的類型。 |
| TripleValueCallback |
定義描述具有三個結果的一般回呼類型- 第一個是 Error，另兩個則是結果值。 |
列舉
| AuthenticationType |
指定 所使用的 |
函數
| an |
傳回自 1970 年 1 月 1 日 00：00：00 UTC 起經過的秒數，直到現在為止的一小時。 |
| encode |
函式詳細資料
anHourFromNow()
傳回自 1970 年 1 月 1 日 00：00：00 UTC 起經過的秒數，直到現在為止的一小時。
function anHourFromNow(): number傳回
number
encodeUriComponentStrict(string)
function encodeUriComponentStrict(str: string): string參數
- str
-
string
傳回
string