azure-iot-common package

クラス

Message

オブジェクトはMessage、デバイスとIoT Hub サービスの間のテレメトリ (device-to-cloud) とコマンド (cloud-to-device) の非同期メッセージングに使用されます。 トランスポートに依存しません。つまり、AMQP、MQTT、HTTP で同じように動作します。

ArgumentError

引数が無効な場合にスローされるエラーです。

ArgumentOutOfRangeError

引数に許容範囲外の値がある場合にスローされるエラーです。

BadDeviceResponseError

デバイスがデバイス メソッドの呼び出しに不適切な応答を送信すると、エラーがスローされます。

CloudToDeviceDetachedError

c2d 機能がトランスポート レベルで動作を停止し、クライアントの起動を再試行する必要があるときに、エラーがスローされます。

DeviceAlreadyExistsError

デバイスの作成に使用されるデバイス ID が既にデバイス ID レジストリに存在する場合にスローされるエラーです。

DeviceMaximumQueueDepthExceededError

デバイスのメッセージ キューがいっぱいになると、エラーがスローされます。

DeviceMessageLockLostError

メッセージに関連付けられているロック トークンが失われるため、メッセージの解決に失敗するとエラーがスローされます。

DeviceMethodsDetachedError

デバイス メソッド機能がトランスポート レベルで動作を停止し、クライアントによる起動の再試行を要求すると、エラーがスローされます。

DeviceNotFoundError

IoT Hub インスタンス レジストリでデバイスが見つからない場合にスローされるエラーです。

DeviceRegistrationFailedError

DPS 登録操作が失敗したときにスローされるエラー

DeviceTimeoutError

デバイスがメソッド呼び出しを時間内に処理しないと、エラーがスローされます。

FormatError

特定の書式を持つ文字列が正しく書式設定されていない場合にスローされるエラーです。

GatewayTimeoutError

IoT Hub インスタンスがデバイス メソッドの呼び出しを時間内に処理しないと、エラーがスローされます。

InternalServerError

内部サーバー エラーが発生したときにスローされるエラー。 バグが見つかった可能性がありますか?

InvalidEtagError

指定された eTag の形式が正しくないか、古い場合にエラーがスローされます。

InvalidOperationError

操作が試行されたが許可されていない場合にスローされるエラー。

IotHubNotFoundError

Azure IoT ハブが見つからなかったときにスローされるエラー。

IotHubQuotaExceededError

Azure IoT Hub クォータを超えたというエラーがスローされました。 クォータは定期的にリセットされます。この操作はそれまで待機する必要があります。 クォータの詳細については、「クォータと調整のAzure IoT Hub」を参照してください。

IoTHubSuspendedError

IoT Hubが中断されたときにエラーがスローされます。

JobNotFoundError

指定した識別子を持つジョブが見つからなかった場合にスローされるエラーです。

MessageTooLargeError

送信されたメッセージが大きすぎる場合にスローされるエラー:最大サイズは 256 Kb です。

NotConnectedError

デバイスが切断され、操作を完了できない場合にエラーがスローされます。

NotImplementedError

機能がまだ実装されていないが、プレースホルダーが存在する場合にスローされるエラー。

OperationCancelledError

任意の操作 (ローカルまたはリモート) が取り消されたときにスローされるエラー

PreconditionFailedError

操作を実行するために満たされているはずの条件が満たされなかった場合にスローされるエラー。

SecurityDeviceError

低レベルのセキュリティ デバイス/ドライバーが失敗すると、エラーがスローされます。

ServiceUnavailableError

サービスが利用できない場合にスローされるエラー。 操作を再試行する必要があります。

ThrottlingError

過剰なアクティビティが原因でIoT Hubが調整されると、エラーがスローされます。 クォータの詳細については、「クォータと調整のAzure IoT Hub」を参照してください。

TimeoutError

タイムアウトが発生したときにスローされるエラー

TooManyDevicesError

特定のハブ上のデバイスの最大数に達すると、エラーがスローされます。

TwinDetachedError

ツイン機能がトランスポート レベルで動作を停止し、クライアントが開始を再試行する必要があるときに、エラーがスローされます。

TwinRequestError

ツイン要求が不明なエラー コードで失敗すると、一般的なエラーがスローされます。

UnauthorizedError

接続パラメーターが間違っており、サーバーが接続を拒否すると、エラーがスローされます。

Connected

トランスポートが正常に接続されたときに返される結果。

Disconnected

トランスポートが正常に切断されたときに返される結果。

MessageAbandoned

メッセージが正常に破棄されたときに返される結果。

MessageCompleted

メッセージが正常に拒否されたときに返される結果。

MessageEnqueued

メッセージが正常にエンキューされたときに返される結果。

MessageRejected

メッセージが正常に拒否されたときに返される結果。

SharedAccessSignatureUpdated

SAS トークンが正常に更新されたときに返される結果。

TransportConfigured

トランスポートが正常に構成されたときに返される結果。

ConnectionString

デバイスまたはクラウド アプリケーションが Azure IoT ハブに接続できるようにするパラメーターについて説明します。

ExponentialBackOffWithJitter

ジッター再試行戦略を使用して指数バックオフを実装します。 次の間隔を計算する関数は次のとおりです (x は x 回目の再試行です): F(x) = min(Cmin+ (2^(x-1)-1) * rand(C * (1 – Jd), C*(1-Ju)), Cmax)

NoRetry

再試行の仮承諾をブロックするスタブ ポリシー。 操作は再試行されません。

RetryOperation

接続、C2D メッセージの受信、テレメトリの送信、ツイン更新などの操作を再試行するために必要なロジックを実装します。

SharedAccessSignature

共有アクセス署名トークンは、(x509 証明書ではなく) 対称キーを使用して Azure IoT ハブとの接続をセキュリティで保護するときに、接続を認証するために使用されます。

インターフェイス

AuthenticationProvider

Azure IoT ハブ インスタンスで認証するためにデバイス クライアントによって使用されるトランスポートに資格情報を提供するために使用されるオブジェクトによって実装される必要があるインターフェイス。

Receiver
RetryPolicy

再試行ポリシー オブジェクトを記述するインターフェイス。 再試行ポリシーは 2 つの要素で構成されます

  • 現在の回数または再試行回数に基づいて、次回再試行を計算するアルゴリズム。
  • 受信したエラーの種類に基づいて、再試行を行う必要があるかどうかを決定するエラー フィルター。

これらの 2 つのコンポーネントは、このインターフェイスで説明されている 2 つのメソッド呼び出しの背後に隠れています。

TransportConfig

資格情報を格納および交換するためにトランスポートと AuthenticationProvider オブジェクトによって使用される構成構造。

X509

トランスポートで使用する X509 証明書とキーを格納するために使用されるオブジェクト。

これは、TLS ソケットを接続するためにNode.jsによって使用される低レベルのオブジェクトに直接渡されます。 https://nodejs.org/api/tls.html#tls_tls_connect_options_callback

型エイリアス

BufferConvertible
ResultWithHttpResponse
Callback

2 つの結果を持つ通常のコールバックを記述する型を定義します。1 つは Error、もう 1 つは結果値です。

DoubleValueCallback

2 つの結果を含むコールバックを記述する型を定義します。

ErrorCallback

Error 結果値のみを使用してコールバックを記述する型を定義します。

HttpResponseCallback

応答、生 HTTP 応答、Error という 3 つの結果を持つコールバックを記述する型を定義します。

NoErrorCallback

エラー以外の結果値を 1 つ持つコールバックを記述する型を定義します。

TripleValueCallback

3 つの結果を含む通常のコールバックを記述する型を定義します。最初の 1 つは Error、残りの 2 つは結果値です。

列挙型

AuthenticationType

によって使用される認証の種類を指定します AuthenticationProvider

機能

anHourFromNow()

1970 年 1 月 1 日 00:00:00 UTC から 1 時間経過した秒数を返します。

encodeUriComponentStrict(string)

関数の詳細

anHourFromNow()

1970 年 1 月 1 日 00:00:00 UTC から 1 時間経過した秒数を返します。

function anHourFromNow(): number

戻り値

number

encodeUriComponentStrict(string)

function encodeUriComponentStrict(str: string): string

パラメーター

str

string

戻り値

string