ServiceBusReceivedMessage interface

メッセージを配信不能にするためのエラーの説明。

deadLetterErrorDescription?: string

プロパティ値

メッセージを配信不能にした理由。

deadLetterReason?: string

プロパティ値

このメッセージが配信不能になるまでに、このメッセージがエンキューされたキューまたはサブスクリプションの名前。 配信不能になり、その後配信不能サブキューから別のエンティティに自動転送されたメッセージでのみ設定されます。 メッセージが配信不能になったエンティティを示します。

deadLetterSource?: string

プロパティ値

このメッセージに対して試行された配信の数です。 メッセージ ロックが期限切れになった場合、またはメッセージの メソッドを使用して abandon() メッセージが明示的に破棄されると、カウントがインクリメントされます。

deliveryCount?: number

プロパティ値

メッセージの元のシーケンス番号。 このプロパティは、自動転送されたメッセージの場合に、元の送信地点で最初にメッセージに割り当てられたシーケンス番号を示します。

enqueuedSequenceNumber?: number

プロパティ値

メッセージが受け入れられ、Service Bus に格納された UTC インスタント。

enqueuedTimeUtc?: Date

プロパティ値

有効期限切れが原因でメッセージが削除対象としてマークされ、エンティティから取得できなくなった UTC 時刻。 このプロパティは、メッセージの他の 2 つのプロパティ ( ) enqueuedTimeUtc + timeToLiveから計算されます。

expiresAtUtc?: Date

プロパティ値

メッセージがキューまたはサブスクリプションでロックされるまでの UTC インスタント。 ロックの有効期限が切れると、 deliveryCount がインクリメントされ、メッセージが再び取得できるようになります。

• メッセージが受信モードで receiveAndDelete 受信された場合は適用されません。 モードの間、すべてのクォーラム構成が無視されます。

lockedUntilUtc?: Date

プロパティ値

ロック トークンは、ブローカーが受信モードで peekLock 保持しているロックへの参照です。 ロックは、製品ドキュメントで詳しく説明されているように、内部的にメッセージを決済するために使用されます

• メッセージが受信モードで receiveAndDelete 受信された場合は適用されません。 モードの間、すべてのクォーラム構成が無視されます。

lockToken?: string

プロパティ値

Service Bus によってメッセージに割り当てられる一意の番号。 このシーケンス番号は、メッセージがブローカーおよび関数によって受け入れおよび格納されるときに真の識別子として割り当てられる 64 ビットの整数です。 パーティション分割されたエンティティの場合、最上位の 16 ビットはパーティション識別子を表します。 シーケンス番号は単調に増加します。 48 - 64 ビット範囲が使い果たされると、0 にロールオーバーされます。

Javascript で現在サポートされている最大安全な整数は です2^53 - 1。 シーケンス番号は、最大 64 ビット長の AMQP Long 型です。 long.js という名前 のライブラリを使用していることを表すために。 お客様は、このライブラリによってエクスポートされた型を Long 使用することを期待しています。

sequenceNumber?: Long

プロパティ値

メッセージの状態は、アクティブ、遅延、またはスケジュールできます。 遅延メッセージには遅延状態があり、スケジュールされたメッセージにはスケジュールされた状態があり、他のすべてのメッセージはアクティブな状態です。

state: "active" | "deferred" | "scheduled"

プロパティ値

カスタム メッセージ メタデータに使用できるアプリケーション固有のプロパティ。

applicationProperties?: {[key: string]: number | boolean | string | Date | null}

プロパティ値

ServiceBusMessage.applicationPropertiesから継承

送信または受信する必要があるメッセージ本文。 メッセージを受信するアプリケーションがこの SDK を使用していない場合は、言語間の互換性を向上させるために、本文のペイロードをバイト配列またはバッファーに変換します。

body: any

プロパティ値

ServiceBusMessage.bodyから継承

メッセージのコンテンツ タイプ。 必要に応じて、メッセージのペイロードを記述します。記述子は RFC2045 セクション 5 の形式 (例: "application/json") に従います。

contentType?: string

プロパティ値

ServiceBusMessage.contentTypeから継承

アプリケーションが関連付けの目的でメッセージのコンテキストを指定できるようにする関連付け識別子 。たとえば、返信先のメッセージの MessageId を反映します。 「メッセージ ルーティングと関連付け」を参照してください。

correlationId?: string | number | Buffer

プロパティ値

ServiceBusMessage.correlationIdから継承

メッセージ識別子は、アプリケーションによって定義される、メッセージとそのペイロードを一意に識別する値です。

注: 整数ではない数値は使用できません。

messageId?: string | number | Buffer

プロパティ値

ServiceBusMessage.messageIdから継承

パーティション分割されたエンティティにメッセージを送信するためのパーティション キー。 最大長は 128 文字です。 パーティション分割されたエンティティの場合、この値を設定すると、関連するメッセージを同じ内部パーティションに割り当てて、送信順序が正しく記録されるようにできます。 パーティションはハッシュ関数でこの値を介して選択され、直接選択することはできません。

• セッション対応エンティティの場合、 プロパティはこの sessionId 値をオーバーライドします。
• パーティション分割されていないエンティティの場合、パーティション キーは無視されます

partitionKey?: string

プロパティ値

ServiceBusMessage.partitionKeyから継承

返信の送信先のエンティティのアドレス。 これはアプリケーションによって定義される省略可能な値であり、メッセージの受信者への応答パスを表す標準的な方法です。 応答が必要な場合、送信者は、この値を応答の送信先にするキューまたはトピックの絶対または相対パスに設定します。 「メッセージ ルーティングと関連付け」を参照してください。

replyTo?: string

プロパティ値

ServiceBusMessage.replyToから継承

アドレスを拡張する replyTo セッション識別子。 最大長は 128 文字です。 この値は、ReplyTo の情報を補足し、応答が応答エンティティに送信されるときに設定する必要がある SessionId を指定します。 「メッセージ ルーティングと関連付け」を参照してください。

replyToSessionId?: string

プロパティ値

ServiceBusMessage.replyToSessionIdから継承

メッセージがエンキューされる UTC の日付と時刻。 このプロパティは UTC で時刻を返します。プロパティを設定する場合は、指定された DateTime 値も UTC である必要があります。 この値は、遅延メッセージ送信用です。 これは、メッセージの送信を将来の特定の時刻に遅延させるために使用されます。 メッセージのエンキュー時間は、メッセージが同時に送信されることを意味するものではありません。 エンキューされますが、実際の送信時間はキューのワークロードとその状態によって異なります。

scheduledEnqueueTimeUtc?: Date

プロパティ値

ServiceBusMessage.scheduledEnqueueTimeUtcから継承

セッション対応エンティティのセッション識別子。 最大長は 128 文字です。 この値はアプリケーションによって定義され、セッションを認識するエンティティの場合に、メッセージのセッションへの所属を指定します。 同じセッション識別子を持つメッセージがまとめてロックされ、正確な順序での処理と多重化が可能になります。 セッションを認識しないエンティティの場合、この値は無視されます。 メッセージ セッション。

sessionId?: string

プロパティ値

ServiceBusMessage.sessionIdから継承

アプリケーション固有のラベル。 このプロパティを使用すると、アプリケーションは、標準化された 受信者にメッセージの目的を示します。 電子メールの件名行に似ています。 マップされた AMQP プロパティは "subject" です。

subject?: string

プロパティ値

ServiceBusMessage.subjectから継承

有効な値に対するメッセージの時刻。 この値は、メッセージが期限切れになるまでの相対的な期間です。これは、 で enqueuedTimeUtcキャプチャされたメッセージがブローカーによって受け入れられ、格納された瞬間から始まります。 明示的に設定しない場合、それぞれのキューまたはトピックの DefaultTimeToLive が値として見なされます。 メッセージ レベル timeToLive の値をエンティティの DefaultTimeToLive 設定より長くすることはできません。その場合は、自動的に調整されます。 「有効期限」を参照してください。

timeToLive?: number

プロパティ値

ServiceBusMessage.timeToLiveから継承

"宛先" アドレス。 このプロパティはルーティング　シナリオでの将来の使用のために予約されており、現在はブローカー自体で無視されます。 アプリケーションは、ルール駆動型 の自動転送チェーン シナリオでこの値を使用して、メッセージの目的の論理宛先を示すことができます。

to?: string

プロパティ値

ServiceBusMessage.toから継承