azure-iot-common package
Osztályok
| Message |
A Message objektum telemetriára (eszközről felhőre) és parancsokra (felhőről eszközre) használható aszinkron üzenetküldésre az eszköz és az IoT Hub szolgáltatás között. Ez transport-agnostic, vagyis ugyanúgy működik az AMQP, az MQTT és a HTTP felett. |
| ArgumentError |
Érvénytelen argumentum esetén megjelenő hiba. |
| ArgumentOutOfRangeError |
Hiba akkor jelenik meg, ha egy argumentum értéke kívül esik az elfogadható tartományon. |
| BadDeviceResponseError |
Hiba történt, amikor egy eszköz rossz választ küld egy eszközmetódus-hívásra. |
| CloudToDeviceDetachedError |
Hiba történt, amikor a c2d szolgáltatás nem működik az átviteli szinten, ezért az ügyfélnek újra meg kell kezdenie. |
| DeviceAlreadyExistsError |
Hiba történt, ha az eszközlétrehozáshoz használt eszközazonosító már létezik az Eszközidentitás-beállításjegyzékben. |
| DeviceMaximumQueueDepthExceededError |
Hiba történt, amikor egy eszköz üzenetsora megtelt. |
| DeviceMessageLockLostError |
Az üzenet rendezésekor hibaüzenet jelenik meg, mert az üzenethez társított zárolási jogkivonat elveszik. |
| DeviceMethodsDetachedError |
Hiba történt, amikor az eszköz metódusai funkció leállt az átviteli szinten, és az ügyfélnek újra meg kell kezdenie az indítást. |
| DeviceNotFoundError |
Hiba történt, ha egy eszköz nem található az IoT Hub-példányok beállításjegyzékében. |
| DeviceRegistrationFailedError |
Hiba történt a DPS-regisztrációs művelet meghiúsulásakor |
| DeviceTimeoutError |
Hiba történt, ha az eszköz nem dolgozza fel időben a metódushívást. |
| FormatError |
Hiba történt, ha egy adott formázással rendelkező sztring nem megfelelően van formázva. |
| GatewayTimeoutError |
Hiba történt, ha az IoT Hub-példány nem dolgozza fel időben az eszköz metódushívását. |
| InternalServerError |
Belső kiszolgálóhiba esetén megjelenő hiba. Lehet, hogy talált egy hibát? |
| InvalidEtagError |
Hiba jelenik meg, ha a megadott eTag helytelenül van formázva vagy elavult. |
| InvalidOperationError |
A művelet megkísérlésekor hiba jelenik meg, de nem engedélyezett. |
| IotHubNotFoundError |
Hiba történt, amikor az Azure IoT Hub nem található. |
| IotHubQuotaExceededError |
Hiba történt az Azure IoT Hub kvótájának túllépése miatt. A kvóták rendszeres időközönként alaphelyzetbe állnak, a műveletnek addig várnia kell. A kvótákról további információt Azure IoT Hub kvótáiról és szabályozásáról |
| IoTHubSuspendedError |
Hiba történt az IoT Hub felfüggesztésekor. |
| JobNotFoundError |
Hiba történt, amikor a megadott azonosítóval rendelkező feladat nem található. |
| MessageTooLargeError |
Hiba történt, ha az elküldött üzenet túl nagy: a maximális méret 256 KB. |
| NotConnectedError |
Hiba történt az eszköz leválasztásakor, és a művelet nem hajtható végre. |
| NotImplementedError |
Hiba történt, ha egy funkció még nincs implementálva, de a helyőrző jelen van. |
| OperationCancelledError |
Hiba történt bármely (helyi vagy távoli) művelet megszakításakor |
| PreconditionFailedError |
Hiba történt, ha egy művelet végrehajtásához teljesíteni kellett volna egy feltételt. |
| SecurityDeviceError |
Hiba történt, ha egy alacsony szintű biztonsági eszköz/illesztőprogram meghibásodik. |
| ServiceUnavailableError |
Hiba történt, ha a szolgáltatás nem érhető el. A műveletet újra meg kell próbálkozni. |
| ThrottlingError |
A túlzott tevékenység miatt az IoT Hub szabályozásakor fellépő hiba. A kvótákról további információt Azure IoT Hub kvótáiról és szabályozásáról |
| TimeoutError |
Időtúllépéskor megjelenő hiba |
| TooManyDevicesError |
Hiba történt, ha egy adott központban elérte az eszközök maximális számát. |
| TwinDetachedError |
Hiba történt, amikor az ikerfunkció nem működik az átviteli szinten, és az ügyfélnek újra meg kell kezdenie az indítást. |
| TwinRequestError |
Általános hiba jelenik meg, ha egy ikerkérés ismeretlen hibakóddal meghiúsul. |
| UnauthorizedError |
Hiba történt, ha a kapcsolat paraméterei hibásak, és a kiszolgáló elutasította a kapcsolatot. |
| Connected |
Az átvitel sikeres csatlakoztatása esetén visszaadott eredmény. |
| Disconnected |
Az átvitel sikeres leválasztásakor visszaadott eredmény. |
| MessageAbandoned |
Az eredmény egy üzenet sikeres elhagyásakor lett visszaadva. |
| MessageCompleted |
Az eredmény egy üzenet sikeres elutasítása után lett visszaadva. |
| MessageEnqueued |
Az eredmény egy üzenet sikeres lekérdezésekor lett visszaadva. |
| MessageRejected |
Az eredmény egy üzenet sikeres elutasítása után lett visszaadva. |
| SharedAccessSignatureUpdated |
Egy SAS-jogkivonat sikeres frissítésekor visszaadott eredmény. |
| TransportConfigured |
Az átvitel sikeres konfigurálásakor visszaadott eredmény. |
| ConnectionString |
Azokat a paramétereket ismerteti, amelyek lehetővé teszik egy eszköz vagy felhőalkalmazás számára az Azure IoT Hubhoz való csatlakozást. |
| ExponentialBackOffWithJitter |
Exponenciális visszalépés implementálása Jitter újrapróbálkozási stratégiával. A következő időköz kiszámításának függvénye a következő (x az xth újrapróbálkozás): F(x) = min(Cmin+ (2^(x-1)-1) * rand(C * (1 – Jd), C*(1-Ju)), Cmax) |
| NoRetry |
Csonkszabályzat, amely blokkolja az újrapróbálkozást feltételesen. A műveletek nem lesznek újrapróbálkozottak. |
| RetryOperation |
Implementálja a szükséges logikát az olyan műveletek újrapróbálásához, mint a csatlakozás, a C2D-üzenetek fogadása, a telemetriai adatok küldése, az ikerfrissítések stb. |
| SharedAccessSignature |
A közös hozzáférésű jogosultságkód-jogkivonatok a kapcsolat hitelesítésére szolgálnak szimmetrikus kulcsokkal (szemben az x509-tanúsítványokkal) az Azure IoT Hubbal való kapcsolat biztonságossá tételéhez. |
Interfészek
| AuthenticationProvider |
Olyan felület, amelyet olyan objektumoknak kell implementálnia, amelyek hitelesítő adatokat biztosítanak az eszközügyfél által az Azure IoT Hub-példányokkal való hitelesítéshez használt átvitelekhez. |
| Receiver | |
| RetryPolicy |
Újrapróbálkozási szabályzatobjektumot leíró felület. Az újrapróbálkozás szabályzatai 2 dologból állnak
Ez a két összetevő két, ezen a felületen ismertetett metódushívás mögött rejtőzik. |
| TransportConfig |
Az átvitelek és |
| X509 |
X509-tanúsítvány és -kulcs tárolására használt objektum a használandó átvitelekhez. Ez közvetlenül a Node.js által a TLS-szoftvercsatornák csatlakoztatásához használt alacsony szintű objektumoknak lesz átadva. https://nodejs.org/api/tls.html#tls_tls_connect_options_callback |
Típusaliasok
| BufferConvertible | |
| ResultWithHttpResponse | |
| Callback |
A normál visszahívást leíró típust definiálja két eredménnyel – az egyik a hiba, a másik pedig az eredményérték. |
| DoubleValueCallback |
A visszahívást leíró típust definiálja két eredménnyel. |
| ErrorCallback |
A visszahívást leíró típust határozza meg, amely csak hibaeredmény-értékkel jelenik meg. |
| HttpResponseCallback |
A visszahívást leíró típust határozza meg három eredménnyel : válasz, nyers HTTP-válasz és hiba. |
| NoErrorCallback |
A visszahívást leíró típust definiálja egy nem hiba eredményértékkel. |
| TripleValueCallback |
A normál visszahívást leíró típust határozza meg három eredménnyel – az első hiba, a másik kettő az eredményérték. |
Enumerációk
| AuthenticationType |
Adja meg az |
Függvények
| an |
Az 1970. január 1. óta eltelt másodperceket adja vissza 00:00:00(UTC) egy óra múlva. |
| encode |
Függvény adatai
anHourFromNow()
Az 1970. január 1. óta eltelt másodperceket adja vissza 00:00:00(UTC) egy óra múlva.
function anHourFromNow(): numberVálaszok
number
encodeUriComponentStrict(string)
function encodeUriComponentStrict(str: string): stringParaméterek
- str
-
string
Válaszok
string