Aracılığıyla paylaş


azure-iot-common package

Sınıflar

Message

Message nesnesi, cihazla IoT Hub hizmeti arasında telemetri (cihazdan buluta) ve komutlar (buluttan cihaza) zaman uyumsuz mesajlaşma için kullanılır. Taşımadan bağımsızdır, yani AMQP, MQTT ve HTTP üzerinde aynı şekilde çalışır.

ArgumentError

Bağımsız değişken geçersiz olduğunda hata oluştu.

ArgumentOutOfRangeError

Bir bağımsız değişken, kabul edilir aralığın dışında bir değere sahip olduğunda hata oluştu.

BadDeviceResponseError

Cihaz bir cihaz yöntemi çağrısına hatalı yanıt gönderdiğinde hata oluştu.

CloudToDeviceDetachedError

c2d özelliği aktarım düzeyinde çalışmayı durdurduğunda ve istemcinin başlatmayı yeniden denemesini gerektirdiğinde hata oluştu.

DeviceAlreadyExistsError

Cihaz oluşturma için kullanılan cihaz kimliği Cihaz Kimliği Kayıt Defteri'nde zaten mevcut olduğunda hata oluştu.

DeviceMaximumQueueDepthExceededError

Bir cihazın ileti kuyruğu dolu olduğunda hata oluştu.

DeviceMessageLockLostError

İletiyle ilişkili kilit belirteci kaybolduğundan iletinin yerleşimi başarısız olduğunda hata oluştu.

DeviceMethodsDetachedError

Cihaz yöntemleri özelliği aktarım düzeyinde çalışmayı durdurup istemcinin başlatmayı yeniden denemesini gerektirdiğinde hata oluştu.

DeviceNotFoundError

Bir cihaz IoT Hub örnek kayıt defterinde bulunamadığında hata oluştu.

DeviceRegistrationFailedError

DPS kayıt işlemi başarısız olduğunda hata oluştu

DeviceTimeoutError

Cihaz yöntem çağrısını zamanında işlemediğinde hata oluştu.

FormatError

Belirli bir biçimlendirmeye sahip olması gereken bir dize düzgün biçimlendirilmediğinde hata oluştu.

GatewayTimeoutError

IoT Hub örneği cihaz yöntemi çağrısını zamanında işlemediğinde hata oluştu.

InternalServerError

Bir iç sunucu hatası oluştuğunda hata oluştu. Bir hata bulmuş olabilir misiniz?

InvalidEtagError

Belirtilen eTag yanlış biçimlendirildiğinde veya güncel olmadığında hata oluştu.

InvalidOperationError

bir işlem denendiğinde ancak izin verilmediğinde hata oluştu.

IotHubNotFoundError

Azure IoT hub'ı bulunamadığında hata oluştu.

IotHubQuotaExceededError

Azure IoT hub kotası aşıldı hatası oluştu. Kotalar düzenli aralıklarla sıfırlanır, bu işlemin o zamana kadar beklemesi gerekir. Kotalar hakkında daha fazla bilgi edinmek için bkz. Azure IoT Hub kotaları ve azaltma

IoTHubSuspendedError

IoT Hub askıya alındığında hata oluştu.

JobNotFoundError

Belirtilen tanımlayıcıya sahip iş bulunamadığında hata oluştu.

MessageTooLargeError

Gönderilen ileti çok büyük olduğunda hata oluştu: en büyük boyut 256 KB'tır.

NotConnectedError

Cihazın bağlantısı kesildiğinde ve işlem tamamlanamadığında hata oluştu.

NotImplementedError

Bir özellik henüz uygulanmadığında ancak yer tutucu mevcut olduğunda hata oluştu.

OperationCancelledError

Herhangi bir işlem (yerel veya uzak) iptal edildiğinde hata oluştu

PreconditionFailedError

bir işlemi yürütmek için karşılanması gereken bir koşul karşılanmadığında hata oluştu.

SecurityDeviceError

Düşük düzeyli bir güvenlik cihazı/sürücüsü başarısız olduğunda hata oluştu.

ServiceUnavailableError

Hizmet kullanılamadığında hata oluştu. İşlem yeniden denenmelidir.

ThrottlingError

Aşırı etkinlik nedeniyle IoT Hub kısıtlandığında hata oluştu. Kotalar hakkında daha fazla bilgi edinmek için bkz. Azure IoT Hub kotaları ve azaltma

TimeoutError

Zaman aşımı oluştuğunda hata oluştu

TooManyDevicesError

Belirli bir hub'da en fazla cihaz sayısına ulaşıldığında hata oluştu.

TwinDetachedError

İkiz özelliği aktarım düzeyinde çalışmayı durdurduğunda ve istemcinin başlatmayı yeniden denemesini gerektirdiğinde hata oluştu.

TwinRequestError

bir ikiz isteği bilinmeyen bir hata koduyla başarısız olduğunda genel hata oluştu.

UnauthorizedError

Bağlantı parametreleri yanlış olduğunda ve sunucu bağlantıyı reddettiğinde hata oluştu.

Connected

Aktarım başarıyla bağlandığında döndürülen sonuç.

Disconnected

Aktarım başarıyla kesildiğinde sonuç döndürülür.

MessageAbandoned

İleti başarıyla bırakıldıktan sonra sonuç döndürüldü.

MessageCompleted

İleti başarıyla reddedildiğinde sonuç döndürüldü.

MessageEnqueued

İleti başarıyla sıraya alındığında sonuç döndürüldü.

MessageRejected

İleti başarıyla reddedildiğinde sonuç döndürüldü.

SharedAccessSignatureUpdated

Sas belirteci başarıyla güncelleştirildiğinde sonuç döndürülür.

TransportConfigured

Aktarım başarıyla yapılandırıldığında döndürülen sonuç.

ConnectionString

Bir cihazın veya bulut uygulamasının Azure IoT hub'ına bağlanmasını sağlayan parametreleri açıklar.

ExponentialBackOffWithJitter

Değişim yeniden deneme stratejisi ile Üstel Geri Alma uygular. Sonraki aralığı hesaplamak için işlev şudur (x x. yeniden denemedir): F(x) = min(Cmin+ (2^(x-1)-1) * rand(C * (1 – Jd), C*(1-Ju)), Cmax)

NoRetry

Herhangi bir yeniden deneme belirsizini engelleyen saplama ilkesi. İşlemler yeniden denenmiyor.

RetryOperation

Bağlanma, C2D iletileri alma, telemetri gönderme, ikiz güncelleştirmeleri gibi işlemleri yeniden denemek için gerekli mantığı uygular.

SharedAccessSignature

Paylaşılan erişim imzası belirteçleri, Azure IoT hub'ı ile bağlantının güvenliğini sağlamak için simetrik anahtarlar (x509 sertifikalarının aksine) kullanılırken bağlantının kimliğini doğrulamak için kullanılır.

Arabirimler

AuthenticationProvider

Bir Azure IoT hub örneğiyle kimlik doğrulaması yapmak için cihaz istemcisi tarafından kullanılan aktarımlara kimlik bilgileri sağlamak için kullanılan nesneler tarafından uygulanması gereken arabirim.

Receiver
RetryPolicy

Yeniden deneme ilkesi nesnesini açıklayan arabirim. Yeniden deneme ilkeleri 2 şeyden oluşur

  • Geçerli sayıya veya yeniden denemelere göre bir sonraki yeniden deneme zamanını hesaplayan bir algoritma.
  • Alınan hata türüne göre yeniden deneme yapılıp yapılmaydığına karar veren bir hata filtresi.

Bu 2 bileşen, bu arabirimde açıklanan 2 yöntem çağrısının arkasına gizlenir.

TransportConfig

Kimlik bilgilerini depolamak ve değiştirmek için aktarımlar ve AuthenticationProvider nesneler tarafından kullanılan yapılandırma yapısı.

X509

Aktarımların kullanması için X509 sertifikasını ve anahtarını depolamak için kullanılan nesne.

Bu doğrudan Node.js tarafından TLS yuvasını bağlamak için kullanılan alt düzey nesnelere geçirilir. https://nodejs.org/api/tls.html#tls_tls_connect_options_callback

Tür Diğer Adları

BufferConvertible
ResultWithHttpResponse
Callback

İki sonuçla normal geri çağırmayı açıklayan türü tanımlar: biri Hata, diğeri sonuç değeridir.

DoubleValueCallback

geri çağırmayı açıklayan türü iki sonuçla tanımlar.

ErrorCallback

Yalnızca Hata sonucu değeriyle geri aramayı açıklayan türü tanımlar.

HttpResponseCallback

Yanıt, ham HTTP yanıtı ve Hata gibi üç sonuçla geri çağırmayı açıklayan türü tanımlar.

NoErrorCallback

Hata olmayan bir sonuç değeriyle geri çağırmayı açıklayan türü tanımlar.

TripleValueCallback

Normal geri çağırmayı üç sonuçla açıklayan türü tanımlar. Bunlardan ilki Hata, diğer ikisi sonuç değerleridir.

Numaralandırmalar

AuthenticationType

tarafından kullanılan kimlik doğrulama türünü belirleyin AuthenticationProvider.

İşlevler

anHourFromNow()

1 Ocak 1970 00:00:00 UTC'den itibaren bir saat sonraya kadar geçen saniyeleri döndürür.

encodeUriComponentStrict(string)

İşlev Ayrıntıları

anHourFromNow()

1 Ocak 1970 00:00:00 UTC'den itibaren bir saat sonraya kadar geçen saniyeleri döndürür.

function anHourFromNow(): number

Döndürülenler

number

encodeUriComponentStrict(string)

function encodeUriComponentStrict(str: string): string

Parametreler

str

string

Döndürülenler

string