azure-iot-common package

Třídy

Message	Objekt Message slouží k telemetrii (zařízení-cloud) a příkazům (cloud-zařízení) asynchronního zasílání zpráv mezi zařízením a službou IoT Hub. Je nezávislá na přenosu, což znamená, že funguje stejně přes AMQP, MQTT a HTTP.
ArgumentError	Při neplatném argumentu došlo k chybě.
ArgumentOutOfRangeError	Chyba vyvolaná v případě, že argument má hodnotu, která je mimo přípustné rozsahy.
BadDeviceResponseError	Při odesílání chybné odpovědi na volání metody zařízení došlo k chybě.
CloudToDeviceDetachedError	Došlo k chybě, když funkce c2d přestala fungovat na úrovni přenosu, což vyžaduje, aby ho klient zkusil spustit znovu.
DeviceAlreadyExistsError	Chyba se vyvolá, když ID zařízení použité k vytvoření zařízení již v registru identit zařízení existuje.
DeviceMaximumQueueDepthExceededError	Při zaplnění fronty zpráv pro zařízení došlo k chybě.
DeviceMessageLockLostError	Při vyrovnání zprávy došlo k chybě, protože token zámku přidružený ke zprávě se ztratí.
DeviceMethodsDetachedError	Chyba vyvolaná, když funkce metod zařízení přestala fungovat na úrovni přenosu, což vyžaduje, aby ho klient zkusil spustit znovu.
DeviceNotFoundError	Chyba vyvolaná v případě, že se v registru instance služby IoT Hub nenašlo zařízení.
DeviceRegistrationFailedError	Chyba vyvolaná při selhání operace registrace SLUŽBY DPS
DeviceTimeoutError	Chyba vyvolaná v případě, že zařízení nezpracuje volání metody včas.
FormatError	Chyba vyvolaná v případě, že řetězec, který má mít určité formátování, není správně naformátován.
GatewayTimeoutError	Chyba vyvolaná v případě, že instance ioT Hubu nezpracuje volání metody zařízení včas.
InternalServerError	Při vnitřní chybě serveru došlo k chybě. Možná jste našli chybu?
InvalidEtagError	Při nesprávném formátování nebo zastaralém formátu značky eTag došlo k chybě.
InvalidOperationError	Při pokusu o operaci došlo k chybě, ale není povolena.
IotHubNotFoundError	Při nenalezení centra Azure IoT došlo k chybě.
IotHubQuotaExceededError	Došlo k chybě, která způsobila překročení kvóty služby Azure IoT Hub. Kvóty se pravidelně obnovují, tato operace bude muset počkat až do té doby. Další informace o kvótách najdete v tématu kvóty služby Azure IoT Hub a omezování
IoTHubSuspendedError	Při pozastavení služby IoT Hub došlo k chybě.
JobNotFoundError	Chyba vyvolaná v případě, že úloha se zadaným identifikátorem nebyla nalezena.
MessageTooLargeError	Při příliš velké velikosti zprávy došlo k chybě: maximální velikost je 256 kB.
NotConnectedError	Při odpojení zařízení došlo k chybě a operaci nelze dokončit.
NotImplementedError	Chyba vyvolaná v případě, že funkce ještě není implementována, ale zástupný symbol je k dispozici.
OperationCancelledError	Chyba vyvolaná při zrušení jakékoli operace (místní nebo vzdálené)
PreconditionFailedError	Při splnění podmínky, která by měla být splněna kvůli provedení operace, došlo k chybě.
SecurityDeviceError	Při selhání zařízení nebo ovladače zabezpečení nízké úrovně došlo k chybě.
ServiceUnavailableError	Při nedostupnosti služby došlo k chybě. Operace by se měla opakovat.
ThrottlingError	Při omezování služby IoT Hub došlo k chybě kvůli nadměrné aktivitě. Další informace o kvótách najdete v tématu kvóty služby Azure IoT Hub a omezování
TimeoutError	Chyba vyvolaná při vypršení časového limitu
TooManyDevicesError	Při dosažení maximálního počtu zařízení v konkrétním centru došlo k chybě.
TwinDetachedError	Při zastavení funkce dvojčete na úrovni přenosu došlo k chybě, která vyžaduje, aby ho klient zkusil spustit znovu.
TwinRequestError	Obecná chyba vyvolaná v případě, že požadavek dvojčete selže s neznámým kódem chyby.
UnauthorizedError	Při nesprávném parametru připojení došlo k chybě a server připojení odmítl.
Connected	Výsledek vrácený při úspěšném připojení přenosu.
Disconnected	Výsledek se vrátí, když se přenos úspěšně odpojí.
MessageAbandoned	Výsledek vrácený při úspěšném opuštění zprávy.
MessageCompleted	Výsledek vrácený, když byla zpráva úspěšně odmítnuta.
MessageEnqueued	Výsledek vrácený při úspěšném zařazení zprávy do fronty.
MessageRejected	Výsledek vrácený, když byla zpráva úspěšně odmítnuta.
SharedAccessSignatureUpdated	Výsledek vrácený při úspěšné aktualizaci tokenu SAS.
TransportConfigured	Výsledek se vrátí při úspěšné konfiguraci přenosu.
ConnectionString	Popisuje parametry, které umožňují zařízení nebo cloudové aplikaci připojit se k centru Azure IoT.
ExponentialBackOffWithJitter	Implementuje exponenciální zpochybnění se strategií opakování Jitter. Funkce pro výpočet dalšího intervalu je následující (x je x. opakování): F(x) = min(Cmin+ (2^(x-1)-1) * rand(C * (1 – Jd), C*(1-Ju)), Cmax)
NoRetry	Zásady zástupných procedur, které blokují všechny pokusy o opakování nezávazně. Operace se neopakují.
RetryOperation	Implementuje potřebnou logiku pro opakování operací, jako je připojení, příjem zpráv C2D, odesílání telemetrie, aktualizace dvojčat atd.
SharedAccessSignature	Tokeny sdíleného přístupového podpisu slouží k ověření připojení při použití symetrických klíčů (na rozdíl od certifikátů x509) k zabezpečení připojení k centru Azure IoT.

Rozhraní

AuthenticationProvider	Rozhraní, které musí být implementováno objekty, které slouží k poskytnutí přihlašovacích údajů k přenosu používanému klientem zařízení k ověření v instanci služby Azure IoT Hub.
Receiver
RetryPolicy	Rozhraní popisující objekt zásad opakování Zásady opakování se skládají ze 2 věcí Algoritmus, který při příštím pokusu provede opakování na základě aktuálního čísla nebo opakování. Filtr chyb, který se rozhodne na základě typu přijaté chyby, ať už se má opakovat, nebo ne. Tyto 2 komponenty skrývají za 2 volání metody popsané v tomto rozhraní.
TransportConfig	Struktura konfigurace používaná přenosy a AuthenticationProvider objekty k ukládání a výměně přihlašovacích údajů.
X509	Objekt použitý k uložení certifikátu a klíče X509 pro přenosy, které se mají použít. Ten se předává přímo do objektů nízké úrovně používaných Node.js pro připojení soketu TLS. https://nodejs.org/api/tls.html#tls_tls_connect_options_callback

Aliasy typu

BufferConvertible
ResultWithHttpResponse
Callback	Definuje typ popisující normální zpětné volání se dvěma výsledky – jedna je Chyba, druhá je výsledná hodnota.
DoubleValueCallback	Definuje typ popisující zpětné volání se dvěma výsledky.
ErrorCallback	Definuje typ popisující zpětné volání pouze s hodnotou výsledku chyby.
HttpResponseCallback	Definuje typ popisující zpětné volání se třemi výsledky – odpověď, nezpracovaná odpověď HTTP a chyba.
NoErrorCallback	Definuje typ popisující zpětné volání s jednou chybovou hodnotou výsledku.
TripleValueCallback	Definuje typ popisující normální zpětné volání se třemi výsledky – první je Chyba, druhé dva jsou výsledné hodnoty.

Výčty

AuthenticationType

Určete typ ověřování používaný AuthenticationProvider.

Funkce

anHourFromNow()	Vrátí sekundy uplynulé od 1. ledna 1970 00:00:00 UTC do jedné hodiny od této chvíle.
encodeUriComponentStrict(string)

Podrobnosti funkce

anHourFromNow()

Vrátí sekundy uplynulé od 1. ledna 1970 00:00:00 UTC do jedné hodiny od této chvíle.

function anHourFromNow(): number

Návraty

number

encodeUriComponentStrict(string)

function encodeUriComponentStrict(str: string): string

Parametry

str

string

Návraty

string