azure-iot-common package

Klasy

Message	Obiekt Message jest używany do telemetrii (urządzenie-chmura) i poleceń (chmura-urządzenie) asynchronicznych komunikatów między urządzeniem a usługą IoT Hub. Jest ona niezależna od transportu, co oznacza, że działa tak samo w przypadku protokołu AMQP, MQTT i HTTP.
ArgumentError	Błąd zgłaszany, gdy argument jest nieprawidłowy.
ArgumentOutOfRangeError	Błąd zgłaszany, gdy argument ma wartość wyrwaną z dopuszczalnego zakresu.
BadDeviceResponseError	Błąd zgłaszany, gdy urządzenie wysyła złą odpowiedź na wywołanie metody urządzenia.
CloudToDeviceDetachedError	Błąd zgłaszany, gdy funkcja c2d przestała działać na poziomie transportu, co wymaga od klienta ponawiania próby jego uruchomienia.
DeviceAlreadyExistsError	Błąd zgłaszany, gdy identyfikator urządzenia używany do tworzenia urządzenia już istnieje w rejestrze tożsamości urządzeń.
DeviceMaximumQueueDepthExceededError	Błąd zgłaszany, gdy kolejka komunikatów dla urządzenia jest pełna.
DeviceMessageLockLostError	Błąd zgłaszany podczas rozliczania komunikatu kończy się niepowodzeniem, ponieważ token blokady skojarzony z komunikatem zostanie utracony.
DeviceMethodsDetachedError	Błąd zgłaszany, gdy funkcja metod urządzeń przestała działać na poziomie transportu, co wymaga od klienta ponawiania próby jego uruchomienia.
DeviceNotFoundError	Błąd zgłaszany, gdy nie można odnaleźć urządzenia w rejestrze wystąpień usługi IoT Hub.
DeviceRegistrationFailedError	Błąd zgłaszany, gdy operacja rejestracji usługi DPS kończy się niepowodzeniem
DeviceTimeoutError	Błąd zgłaszany, gdy urządzenie nie przetwarza wywołania metody w czasie.
FormatError	Błąd zgłaszany, gdy ciąg, który ma mieć określone formatowanie, nie jest poprawnie sformatowany.
GatewayTimeoutError	Błąd zgłaszany, gdy wystąpienie usługi IoT Hub nie przetwarza wywołania metody urządzenia w czasie.
InternalServerError	Błąd zgłaszany po wystąpieniu wewnętrznego błędu serwera. Być może znaleziono usterkę?
InvalidEtagError	Błąd zgłaszany, gdy określony element eTag jest niepoprawnie sformatowany lub nieaktualny.
InvalidOperationError	Błąd zgłaszany, gdy próba wykonania operacji jest niedozwolona.
IotHubNotFoundError	Błąd zgłaszany, gdy nie znaleziono centrum Azure IoT Hub.
IotHubQuotaExceededError	Błąd zgłaszany został przekroczony limit przydziału usługi Azure IoT Hub. Przydziały są okresowo resetowane. Ta operacja będzie musiała poczekać do tego czasu. Aby dowiedzieć się więcej o limitach przydziału, zobacz limity przydziału usługi Azure IoT Hub i ograniczanie przepustowości
IoTHubSuspendedError	Błąd zgłaszany, gdy usługa IoT Hub została zawieszona.
JobNotFoundError	Błąd zgłaszany, gdy nie można odnaleźć zadania z określonym identyfikatorem.
MessageTooLargeError	Błąd zgłaszany, gdy wysłany komunikat jest zbyt duży: maksymalny rozmiar to 256 Kb.
NotConnectedError	Błąd zgłaszany po rozłączeniu urządzenia i nie można ukończyć operacji.
NotImplementedError	Błąd zgłaszany, gdy funkcja nie jest jeszcze zaimplementowana, ale symbol zastępczy jest obecny.
OperationCancelledError	Błąd zgłaszany po anulowaniu dowolnej operacji (lokalnej lub zdalnej)
PreconditionFailedError	Błąd zgłaszany, gdy warunek, który powinien zostać spełniony, aby wykonać operację, nie był.
SecurityDeviceError	Błąd zgłaszany, gdy urządzenie/sterownik zabezpieczeń niskiego poziomu kończy się niepowodzeniem.
ServiceUnavailableError	Błąd zgłaszany, gdy usługa jest niedostępna. Operacja powinna zostać ponowiona.
ThrottlingError	Błąd zgłaszany, gdy usługa IoT Hub jest ograniczana z powodu nadmiernej aktywności. Aby dowiedzieć się więcej o limitach przydziału, zobacz limity przydziału usługi Azure IoT Hub i ograniczanie przepustowości
TimeoutError	Błąd zgłaszany w przypadku przekroczenia limitu czasu
TooManyDevicesError	Błąd zgłaszany, gdy osiągnięto maksymalną liczbę urządzeń w określonym centrum.
TwinDetachedError	Błąd zgłaszany, gdy funkcja bliźniaczej reprezentacji przestała działać na poziomie transportu, co wymaga od klienta ponawiania próby jego uruchomienia.
TwinRequestError	Błąd ogólny zgłaszany, gdy żądanie reprezentacji bliźniaczej kończy się niepowodzeniem z nieznanym kodem błędu.
UnauthorizedError	Błąd zgłaszany, gdy parametry połączenia są nieprawidłowe, a serwer odmówił połączenia.
Connected	Wynik zwracany po pomyślnym połączeniu transportu.
Disconnected	Wynik zwracany po pomyślnym rozłączeniu transportu.
MessageAbandoned	Wynik został zwrócony, gdy komunikat został pomyślnie porzucony.
MessageCompleted	Wynik został zwrócony, gdy komunikat został pomyślnie odrzucony.
MessageEnqueued	Wynik został zwrócony, gdy komunikat został pomyślnie w kolejce.
MessageRejected	Wynik został zwrócony, gdy komunikat został pomyślnie odrzucony.
SharedAccessSignatureUpdated	Wynik zwrócony po pomyślnym zaktualizowaniu tokenu SAS.
TransportConfigured	Wynik zwracany po pomyślnym skonfigurowaniu transportu.
ConnectionString	Opisuje parametry, które umożliwiają urządzeniu lub aplikacji w chmurze łączenie się z centrum Azure IoT Hub.
ExponentialBackOffWithJitter	Implementuje wycofywanie wykładnicze ze strategią jitter ponawiania prób. Funkcja obliczania następnego interwału jest następująca (x to x ponawianie próby): F(x) = min(Cmin+ (2^(x-1)-1) * rand(C * (1 – Jd), C*(1-Ju)), Cmax)
NoRetry	Zasady wycinków blokujące wszelkie wstępne próby. Operacje nie są ponawiane.
RetryOperation	Implementuje niezbędną logikę do ponawiania prób operacji, takich jak nawiązywanie połączenia, odbieranie komunikatów C2D, wysyłanie danych telemetrycznych, aktualizacje bliźniaczej reprezentacji itp.
SharedAccessSignature	Tokeny sygnatury dostępu współdzielonego są używane do uwierzytelniania połączenia podczas korzystania z kluczy symetrycznych (w przeciwieństwie do certyfikatów x509) w celu zabezpieczenia połączenia z centrum Azure IoT Hub.

Interfejsy

AuthenticationProvider	Interfejs, który musi być implementowany przez obiekty, które są używane do dostarczania poświadczeń do transportu używanego przez klienta urządzenia do uwierzytelniania w wystąpieniu usługi Azure IoT Hub.
Receiver
RetryPolicy	Interfejs opisujący obiekt zasad ponawiania prób. Zasady ponawiania prób składają się z 2 elementów Algorytm, który oblicza następny raz, aby ponowić próbę na podstawie bieżącej liczby lub ponownych prób. Filtr błędu, który decyduje, na podstawie typu odebranego błędu, czy powinno nastąpić ponowienie próby. Te 2 składniki ukrywają się za 2 wywołaniami metod opisanymi w tym interfejsie.
TransportConfig	Struktura konfiguracji używana przez transporty i obiekty AuthenticationProvider do przechowywania i wymiany poświadczeń.
X509	Obiekt używany do przechowywania certyfikatu X509 i klucza do transportu do użycia. Jest on przekazywany bezpośrednio do obiektów niskiego poziomu używanych przez Node.js w celu połączenia gniazda TLS. https://nodejs.org/api/tls.html#tls_tls_connect_options_callback

Aliasy typu

BufferConvertible
ResultWithHttpResponse
Callback	Definiuje typ opisujący regularne wywołanie zwrotne z dwoma wynikami — jeden to Błąd, drugi to wartość wyniku.
DoubleValueCallback	Definiuje typ opisujący wywołanie zwrotne z dwoma wynikami.
ErrorCallback	Definiuje typ opisujący wywołanie zwrotne tylko z wartością wyniku błędu.
HttpResponseCallback	Definiuje typ opisujący wywołanie zwrotne z trzema wynikami — odpowiedź, nieprzetworzona odpowiedź HTTP i błąd.
NoErrorCallback	Definiuje typ opisujący wywołanie zwrotne z jedną wartością wyniku bez błędu.
TripleValueCallback	Definiuje typ opisujący regularne wywołanie zwrotne z trzema wynikami — pierwszy z nich to Błąd, pozostałe dwa są wartościami wynikowymi.

Wyliczenia

AuthenticationType

Wyznaczanie typu uwierzytelniania używanego przez AuthenticationProvider.

Funkcje

anHourFromNow()	Zwraca liczbę sekund, które upłynęły od 1 stycznia 1970 r. 00:00:00 UTC do jednej godziny od tej pory.
encodeUriComponentStrict(string)

Szczegóły funkcji

anHourFromNow()

Zwraca liczbę sekund, które upłynęły od 1 stycznia 1970 r. 00:00:00 UTC do jednej godziny od tej pory.

function anHourFromNow(): number

Zwraca

number

encodeUriComponentStrict(string)

function encodeUriComponentStrict(str: string): string

Parametry

str

string

Zwraca

string