azure-iot-common package
Klasser
| Message | Det Message objektet används för telemetri (enhet till moln) och kommandon (moln-till-enhet) asynkrona meddelanden mellan enheten och IoT Hub-tjänsten. Det är transportagnostiskt, vilket innebär att det fungerar på samma sätt över AMQP, MQTT och HTTP. | 
| ArgumentError | Ett fel uppstod när ett argument är ogiltigt. | 
| ArgumentOutOfRangeError | Ett fel uppstod när ett argument har ett värde som ligger inom det tillåtna intervallet. | 
| BadDeviceResponseError | Ett fel uppstod när en enhet skickar ett felaktigt svar på ett enhetsmetodanrop. | 
| CloudToDeviceDetachedError | Ett fel uppstod när c2d-funktionen slutade fungera på transportnivå, vilket krävde att klienten försökte starta den igen. | 
| DeviceAlreadyExistsError | Ett fel uppstod när enhets-ID:t som användes för att skapa enheten redan finns i enhetsidentitetsregistret. | 
| DeviceMaximumQueueDepthExceededError | Ett fel uppstod när meddelandekön för en enhet är full. | 
| DeviceMessageLockLostError | Ett fel uppstod när ett meddelande skulle åtgärdas eftersom låstoken som är associerad med meddelandet går förlorad. | 
| DeviceMethodsDetachedError | Ett fel uppstod när funktionen för enhetsmetoder slutade fungera på transportnivå, vilket krävde att klienten försökte starta den igen. | 
| DeviceNotFoundError | Ett fel uppstod när det inte gick att hitta en enhet i IoT Hub-instansregistret. | 
| DeviceRegistrationFailedError | Fel som uppstår när en DPS-registreringsåtgärd misslyckas | 
| DeviceTimeoutError | Ett fel uppstod när enheten inte bearbetar metodanropet i tid. | 
| FormatError | Ett fel uppstod när en sträng som ska ha en specifik formatering inte är korrekt formaterad. | 
| GatewayTimeoutError | Ett fel uppstod när IoT Hub-instansen inte bearbetar enhetsmetodens anrop i tid. | 
| InternalServerError | Ett fel uppstod när ett internt serverfel uppstod. Du kanske har hittat en bugg? | 
| InvalidEtagError | Ett fel uppstod när den angivna eTag-koden är felaktigt formaterad eller inaktuell. | 
| InvalidOperationError | Ett fel uppstod när en åtgärd försökte utföras, men tillåts inte. | 
| IotHubNotFoundError | Ett fel uppstod när Azure IoT-hubben inte hittades. | 
| IotHubQuotaExceededError | Ett fel uppstod när Azure IoT Hub-kvoten överskreds. Kvoterna återställs regelbundet. Den här åtgärden måste vänta tills dess. Mer information om kvoter finns i Azure IoT Hub-kvoter och begränsning | 
| IoTHubSuspendedError | Ett fel uppstod när IoT Hub har pausats. | 
| JobNotFoundError | Ett fel uppstod när jobbet med den angivna identifieraren inte hittades. | 
| MessageTooLargeError | Ett fel uppstod när meddelandet som skickades är för stort: den maximala storleken är 256 KB. | 
| NotConnectedError | Ett fel uppstod när enheten är frånkopplad och åtgärden inte kan slutföras. | 
| NotImplementedError | Ett fel uppstod när en funktion inte har implementerats ännu, men platshållaren finns. | 
| OperationCancelledError | Fel som uppstår när en åtgärd (lokal eller fjärransluten) avbryts | 
| PreconditionFailedError | Ett fel uppstod när ett villkor som skulle ha uppfyllts för att köra en åtgärd inte var det. | 
| SecurityDeviceError | Fel som uppstår när en säkerhetsenhet/drivrutin på låg nivå misslyckas. | 
| ServiceUnavailableError | Ett fel uppstod när tjänsten inte är tillgänglig. Åtgärden bör utföras på nytt. | 
| ThrottlingError | Fel som utlöses när IoT Hub begränsas på grund av överdriven aktivitet. Mer information om kvoter finns i Azure IoT Hub-kvoter och begränsning | 
| TimeoutError | Fel som utlöses när en tidsgräns inträffar | 
| TooManyDevicesError | Ett fel uppstod när det maximala antalet enheter på en specifik hubb har nåtts. | 
| TwinDetachedError | Ett fel uppstod när tvillingfunktionen slutade fungera på transportnivå, vilket krävde att klienten försökte starta den igen. | 
| TwinRequestError | Allmänt fel uppstår när en tvillingbegäran misslyckas med en okänd felkod. | 
| UnauthorizedError | Fel uppstod när anslutningsparametrarna är felaktiga och servern nekade anslutningen. | 
| Connected | Resultatet returnerades när en transport har anslutits. | 
| Disconnected | Resultatet returneras när en transport kopplas från. | 
| MessageAbandoned | Resultatet returnerades när ett meddelande avbröts. | 
| MessageCompleted | Resultatet returnerades när ett meddelande avvisades. | 
| MessageEnqueued | Resultatet returnerades när ett meddelande har sparats. | 
| MessageRejected | Resultatet returnerades när ett meddelande avvisades. | 
| SharedAccessSignatureUpdated | Resultatet returnerades när en SAS-token har uppdaterats. | 
| TransportConfigured | Resultatet returnerades när en transport har konfigurerats. | 
| ConnectionString | Beskriver parametrarna som gör det möjligt för en enhet eller ett molnprogram att ansluta till en Azure IoT-hubb. | 
| ExponentialBackOffWithJitter | Implementerar en exponentiell backoff med jitter-återförsöksstrategi. Funktionen för att beräkna nästa intervall är följande (x är det x:e återförsöket): F(x) = min(Cmin+ (2^(x-1)-1) * rand(C * (1 – Jd), C*(1-Ju)), Cmax) | 
| NoRetry | Stub-princip som blockerar eventuella återförsök preliminärt. Åtgärder görs inte på nytt. | 
| RetryOperation | Implementerar den logik som krävs för att försöka igen, till exempel ansluta, ta emot C2D-meddelanden, skicka telemetri, tvillinguppdateringar osv. | 
| SharedAccessSignature | Signaturtoken för delad åtkomst används för att autentisera anslutningen när du använder symmetriska nycklar (till skillnad från x509-certifikat) för att skydda anslutningen till Azure IoT-hubben. | 
Gränssnitt
| AuthenticationProvider | Gränssnitt som måste implementeras av objekt som används för att ange autentiseringsuppgifter för de transporter som används av enhetsklienten för att autentisera med en Azure IoT Hub-instans. | 
| Receiver | |
| RetryPolicy | Gränssnitt som beskriver ett principobjekt för återförsök. Återförsöksprinciper består av två saker 
 De två komponenterna döljer sig bakom 2 metodanrop som beskrivs i det här gränssnittet. | 
| TransportConfig | Konfigurationsstruktur som används av transporter och  | 
| X509 | Objekt som används för att lagra ett X509-certifikat och en nyckel som transporterna ska använda. Detta skickas direkt ned till de lågnivåobjekt som används av Node.js för att ansluta TLS-socketen. https://nodejs.org/api/tls.html#tls_tls_connect_options_callback | 
Typalias
| BufferConvertible | |
| ResultWithHttpResponse | |
| Callback | Definierar typ som beskriver vanlig återanrop med två resultat – ett är Felet, det andra är resultatvärdet. | 
| DoubleValueCallback | Definierar typ som beskriver motringning med två resultat. | 
| ErrorCallback | Definierar typ som beskriver motringning med endast felresultatvärde. | 
| HttpResponseCallback | Definierar typ som beskriver återanrop med tre resultat – svar, rå HTTP-svar och ett fel. | 
| NoErrorCallback | Definierar typ som beskriver motringning med ett resultatvärde som inte är fel. | 
| TripleValueCallback | Definierar typ som beskriver regelbundet återanrop med tre resultat – den första är Fel, de andra två är resultatvärdena. | 
Uppräkningar
| AuthenticationType | Ange vilken typ av autentisering som används av en  | 
Funktioner
| an | Returnerar sekunderna som förflutit sedan den 1 januari 1970 00:00:00 UTC till en timme från och med nu. | 
| encode | 
Funktionsinformation
		anHourFromNow()
	   
	Returnerar sekunderna som förflutit sedan den 1 januari 1970 00:00:00 UTC till en timme från och med nu.
function anHourFromNow(): numberReturer
number
		encodeUriComponentStrict(string)
	   
	function encodeUriComponentStrict(str: string): stringParametrar
- str
- 
				string 
Returer
string