azure-iot-common package
Classi
Message |
L'oggetto Message viene usato per la telemetria (da dispositivo a cloud) e i comandi (da cloud a dispositivo) per la messaggistica asincrona tra il dispositivo e il servizio hub IoT. È indipendente dal trasporto, ovvero funziona allo stesso modo su AMQP, MQTT e HTTP. |
ArgumentError |
Errore generato quando un argomento non è valido. |
ArgumentOutOfRangeError |
Errore generato quando un argomento ha un valore esterno all'intervallo consentito. |
BadDeviceResponseError |
Errore generato quando un dispositivo invia una risposta non valida a una chiamata al metodo del dispositivo. |
CloudToDeviceDetachedError |
Errore generato quando la funzionalità c2d ha smesso di funzionare a livello di trasporto, richiedendo al client di riprovare l'avvio. |
DeviceAlreadyExistsError |
Errore generato quando l'ID dispositivo usato per la creazione del dispositivo esiste già nel Registro delle identità del dispositivo. |
DeviceMaximumQueueDepthExceededError |
Errore generato quando la coda di messaggi per un dispositivo è piena. |
DeviceMessageLockLostError |
Errore generato durante la risoluzione di un messaggio non riuscito perché il token di blocco associato al messaggio viene perso. |
DeviceMethodsDetachedError |
Errore generato quando la funzionalità dei metodi del dispositivo ha smesso di funzionare a livello di trasporto, richiedendo al client di riprovare l'avvio. |
DeviceNotFoundError |
Errore generato quando non è possibile trovare un dispositivo nel Registro di sistema dell'istanza di hub IoT. |
DeviceRegistrationFailedError |
Errore generato quando un'operazione di registrazione del servizio Device Provisioning ha esito negativo |
DeviceTimeoutError |
Errore generato quando il dispositivo non elabora la chiamata al metodo nel tempo. |
FormatError |
Errore generato quando una stringa che dovrebbe avere una formattazione specifica non è formattata correttamente. |
GatewayTimeoutError |
Errore generato quando l'istanza di hub IoT non elabora la chiamata al metodo del dispositivo nel tempo. |
InternalServerError |
Errore generato quando si è verificato un errore interno del server. È possibile che sia stato trovato un bug? |
InvalidEtagError |
Errore generato quando l'eTag specificato non è formattato correttamente o non aggiornato. |
InvalidOperationError |
Viene generato un errore quando viene tentata un'operazione ma non è consentita. |
IotHubNotFoundError |
Errore generato quando l'hub IoT di Azure non è stato trovato. |
IotHubQuotaExceededError |
Errore durante il quale è stata superata la quota dell'hub IoT di Azure. Le quote vengono reimpostate periodicamente, questa operazione dovrà attendere fino a allora. Per altre informazioni sulle quote, vedere hub IoT di Azure quote e limitazioni |
IoTHubSuspendedError |
Errore generato quando hub IoT è stato sospeso. |
JobNotFoundError |
Errore generato quando il processo con l'identificatore specificato non è stato trovato. |
MessageTooLargeError |
Errore generato quando il messaggio inviato è troppo grande: la dimensione massima è 256 Kb. |
NotConnectedError |
Errore generato quando il dispositivo viene disconnesso e l'operazione non può essere completata. |
NotImplementedError |
Errore generato quando una funzionalità non è ancora implementata, ma il segnaposto è presente. |
OperationCancelledError |
Errore generato quando un'operazione (locale o remota) viene annullata |
PreconditionFailedError |
Errore generato quando non è stata soddisfatta una condizione che deve essere stata soddisfatta per eseguire un'operazione. |
SecurityDeviceError |
Errore generato quando un dispositivo/driver di sicurezza di basso livello ha esito negativo. |
ServiceUnavailableError |
Errore generato quando il servizio non è disponibile. L'operazione deve essere ritentata. |
ThrottlingError |
Errore generato quando hub IoT è limitato a causa di un'attività eccessiva. Per altre informazioni sulle quote, vedere hub IoT di Azure quote e limitazioni |
TimeoutError |
Errore generato quando si verifica un timeout |
TooManyDevicesError |
Errore generato quando è stato raggiunto il numero massimo di dispositivi in un hub specifico. |
TwinDetachedError |
Errore generato quando la funzionalità gemella smette di funzionare a livello di trasporto, richiedendo al client di riprovare a avviarla. |
TwinRequestError |
Errore generico generato quando una richiesta del gemello ha esito negativo con un codice di errore sconosciuto. |
UnauthorizedError |
Errore generato quando i parametri di connessione sono errati e il server ha rifiutato la connessione. |
Connected |
Risultato restituito quando un trasporto è connesso correttamente. |
Disconnected |
Risultato restituito quando un trasporto viene disconnesso correttamente. |
MessageAbandoned |
Risultato restituito quando un messaggio è stato abbandonato correttamente. |
MessageCompleted |
Risultato restituito quando un messaggio è stato rifiutato correttamente. |
MessageEnqueued |
Risultato restituito quando un messaggio è stato accodato correttamente. |
MessageRejected |
Risultato restituito quando un messaggio è stato rifiutato correttamente. |
SharedAccessSignatureUpdated |
Risultato restituito quando un token di firma di accesso condiviso è stato aggiornato correttamente. |
TransportConfigured |
Risultato restituito quando un trasporto è configurato correttamente. |
ConnectionString |
Descrive i parametri che consentono a un dispositivo o a un'applicazione cloud di connettersi a un hub IoT di Azure. |
ExponentialBackOffWithJitter |
Implementa un backoff esponenziale con la strategia di ripetizione dei tentativi jitter. La funzione per calcolare l'intervallo successivo è la seguente (x è la xth retry): F(x) = min(Cmin+ (2^(x-1)-1) * rand(C * (1 – Jd), C*(1-Ju)), Cmax) |
NoRetry |
Criterio Stub che blocca qualsiasi tentativo provvisorio. Le operazioni non vengono ritentate. |
RetryOperation |
Implementa la logica necessaria per ripetere operazioni, ad esempio la connessione, la ricezione di messaggi C2D, l'invio di dati di telemetria, gli aggiornamenti dei dispositivi gemelli e così via. |
SharedAccessSignature |
I token di firma di accesso condiviso vengono usati per autenticare la connessione quando si usano chiavi simmetriche (anziché certificati x509) per proteggere la connessione con l'hub IoT di Azure. |
Interfacce
AuthenticationProvider |
Interfaccia che deve essere implementata da oggetti usati per fornire le credenziali ai trasporti usati dal client del dispositivo per l'autenticazione con un'istanza dell'hub IoT di Azure. |
Receiver | |
RetryPolicy |
Interfaccia che descrive un oggetto criteri di ripetizione dei tentativi. I criteri di ripetizione dei tentativi sono costituiti da 2 elementi
Questi 2 componenti si nascondono dietro 2 chiamate di metodo descritte in questa interfaccia. |
TransportConfig |
Struttura di configurazione utilizzata dai trasporti e |
X509 |
Oggetto utilizzato per archiviare un certificato X509 e una chiave da usare per i trasporti. Questo viene passato direttamente agli oggetti di basso livello usati da Node.js per connettere il socket TLS. https://nodejs.org/api/tls.html#tls_tls_connect_options_callback |
Alias tipo
BufferConvertible | |
ResultWithHttpResponse | |
Callback |
Definisce il tipo che descrive il callback regolare con due risultati, uno è Error, l'altro è il valore del risultato. |
DoubleValueCallback |
Definisce il tipo che descrive il callback con due risultati. |
ErrorCallback |
Definisce il tipo che descrive il callback con solo valore risultato errore. |
HttpResponseCallback |
Definisce il tipo che descrive il callback con tre risultati: risposta, risposta HTTP non elaborata e errore. |
NoErrorCallback |
Definisce il tipo che descrive il callback con un valore del risultato non di errore. |
TripleValueCallback |
Definisce il tipo che descrive il callback regolare con tre risultati: il primo è Error, gli altri due sono i valori dei risultati. |
Enumerazioni
AuthenticationType |
Designare il tipo di autenticazione usato da un oggetto |
Funzioni
an |
Restituisce i secondi trascorsi dal 1° gennaio 1970 00:00:00 UTC fino a un'ora da ora. |
encode |
Dettagli funzione
anHourFromNow()
Restituisce i secondi trascorsi dal 1° gennaio 1970 00:00:00 UTC fino a un'ora da ora.
function anHourFromNow(): number
Restituisce
number
encodeUriComponentStrict(string)
function encodeUriComponentStrict(str: string): string
Parametri
- str
-
string
Restituisce
string