azure-iot-common package

Třídy

Message	Objekt se Message používá pro telemetrii (zařízení-cloud) a příkazy (cloud-zařízení) a asynchronní 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ým způsobem jako AMQP, MQTT a HTTP.
ArgumentError	Pokud je argument neplatný, vyvolá se chyba.
ArgumentOutOfRangeError	Chyba vyvolá, když argument obsahuje hodnotu, která je mimo povolený rozsah.
BadDeviceResponseError	Došlo k chybě, když zařízení odešle špatnou odpověď na volání metody zařízení.
CloudToDeviceDetachedError	Došlo k chybě, když funkce c2d přestala fungovat na úrovni přenosu, což vyžaduje, aby se klient pokusit ji znovu spustit.
DeviceAlreadyExistsError	Došlo k chybě, pokud ID zařízení použité k vytvoření zařízení již existuje v registru identit zařízení.
DeviceMaximumQueueDepthExceededError	Při zaplněné frontě zpráv pro zařízení došlo k chybě.
DeviceMessageLockLostError	Chyba vyvolaná při vyřešení zprávy se nezdaří, protože dojde ke ztrátě tokenu zámku přidruženého ke zprávě.
DeviceMethodsDetachedError	Došlo k chybě, když funkce metod zařízení přestala fungovat na úrovni přenosu, což vyžaduje, aby se klient pokusit ji znovu spustit.
DeviceNotFoundError	Pokud zařízení nelze najít v registru instance IoT Hub, dojde k chybě.
DeviceRegistrationFailedError	Při selhání operace registrace DPS došlo k chybě
DeviceTimeoutError	Došlo k chybě, když zařízení nezpracuje volání metody včas.
FormatError	Pokud řetězec, který by měl mít určité formátování, není správně naformátovaný, dojde k chybě.
GatewayTimeoutError	Pokud instance IoT Hub nezpracuje volání metody zařízení včas, dojde k chybě.
InternalServerError	Při vnitřní chybě serveru došlo k chybě. Možná jste našli chybu?
InvalidEtagError	Chyba vyvolána, když je zadaná značka eTag nesprávně naformátovaná nebo za aktuální.
InvalidOperationError	Při pokusu o operaci dojde k chybě, která však není povolena.
IotHubNotFoundError	Při nenalezení centra Azure IoT došlo k chybě.
IotHubQuotaExceededError	Došlo k chybě kvůli překročení kvóty služby Azure IoT Hub. Kvóty se pravidelně resetují. Tato operace bude muset počkat do té doby. Další informace o kvótách najdete v tématu Azure IoT Hub kvót a omezování.
IoTHubSuspendedError	Při pozastavení IoT Hub došlo k chybě.
JobNotFoundError	Došlo k chybě, když nebyla nalezena úloha se zadaným identifikátorem.
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í a operaci nelze dokončit, dojde k chybě.
NotImplementedError	Dojde k chybě, když funkce ještě není implementována, ale zástupný symbol je k dispozici.
OperationCancelledError	Při zrušení jakékoli operace (místní nebo vzdálené) došlo k chybě.
PreconditionFailedError	Došlo k chybě, pokud nebyla splněna podmínka, která měla být splněna pro provedení operace.
SecurityDeviceError	Při selhání zařízení nebo ovladače zabezpečení nízké úrovně dojde k chybě.
ServiceUnavailableError	Při nedostupnosti služby došlo k chybě. Operace by se měla opakovat.
ThrottlingError	Při omezování IoT Hub kvůli nadměrné aktivitě došlo k chybě. Další informace o kvótách najdete v tématu Azure IoT Hub kvót a omezování.
TimeoutError	Při vypršení časového limitu došlo k chybě
TooManyDevicesError	Při dosažení maximálního počtu zařízení v konkrétním centru dojde k chybě.
TwinDetachedError	Došlo k chybě, když funkce dvojčete přestala fungovat na úrovni přenosu, což vyžaduje, aby se klient pokusit ji znovu spustit.
TwinRequestError	Obecná chyba vyvolána, když požadavek dvojčete selže s neznámým kódem chyby.
UnauthorizedError	Chyba se vyvolá v případě, že jsou nesprávné parametry připojení a server připojení odmítl.
Connected	Výsledek vrácený po úspěšném připojení přenosu.
Disconnected	Výsledek vrácený po úspěšném odpojení přenosu.
MessageAbandoned	Výsledek vrácený po úspěšném opuštění zprávy
MessageCompleted	Výsledek vrácený po úspěšném odmítnutí zprávy.
MessageEnqueued	Výsledek vrácený po úspěšném zařazení zprávy do fronty.
MessageRejected	Výsledek vrácený po úspěšném odmítnutí zprávy.
SharedAccessSignatureUpdated	Výsledek vrácený po úspěšné aktualizaci tokenu SAS
TransportConfigured	Výsledek vrácený po úspěšné konfiguraci přenosu.
ConnectionString	Popisuje parametry, které umožňují zařízení nebo cloudové aplikaci připojit se ke službě Azure IoT Hub.
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 xth 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í nezávazné opakování. Operace se neopakují.
RetryOperation	Implementuje logiku potřebnou k 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í ke službě Azure IoT Hub.

Rozhraní

AuthenticationProvider	Rozhraní, které musí být implementováno objekty, které se používají k poskytování přihlašovacích údajů k přenosům používaným 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 položek. Algoritmus, který vypočítá příští opakování na základě aktuálního čísla nebo opakování. Filtr chyb, který na základě typu přijaté chyby rozhoduje, jestli má dojít k opakování. Tyto 2 komponenty se skrývají za voláním metody 2 popsanými 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 X509 a klíče pro přenosy k použití. To se předává přímo objektům nízké úrovně, které používají Node.js pro připojení k soketu TLS. https://nodejs.org/api/tls.html#tls_tls_connect_options_callback

Aliasy typu

BufferConvertible
ResultWithHttpResponse
Callback	Definuje typ popisující běžné zpětné volání se dvěma výsledky – jedním je chyba a druhým hodnota výsledku.
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 hodnotou výsledku bez chyby.
TripleValueCallback	Definuje typ popisující běžné zpětné volání se třemi výsledky – první z nich je Chyba a další dva jsou výsledné hodnoty.

Výčty

AuthenticationType

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

Funkce

anHourFromNow()	Vrátí sekundy, které uplynuly od 1. ledna 1970, 00:00:00 UTC do jedné hodiny.
encodeUriComponentStrict(string)

Podrobnosti funkce

anHourFromNow()

Vrátí sekundy, které uplynuly od 1. ledna 1970, 00:00:00 UTC do jedné hodiny.

function anHourFromNow(): number

Návraty

number

encodeUriComponentStrict(string)

function encodeUriComponentStrict(str: string): string

Parametry

str

string

Návraty

string