ServiceBusReceivedMessage interface

パッケージ:

@azure/service-bus

ピーク操作中に Service Bus から受信したメッセージについて説明します。そのため解決できません。

Extends

ServiceBusMessage

プロパティ

deadLetterErrorDescription	メッセージを配信不能にするためのエラーの説明。
deadLetterReason	メッセージを配信不能にした理由。
deadLetterSource	メッセージが配信不能になるまでに、このメッセージがエンキューされたキューまたはサブスクリプションの名前。 配信不能になり、その後配信不能サブキューから別のエンティティに自動転送されたメッセージでのみ設定されます。 メッセージが配信不能になったエンティティを示します。
deliveryCount	このメッセージに対して試行された配信の数。 このカウントは、メッセージ ロックの有効期限が切れるか、メッセージの abandon() メソッドを使用してメッセージが明示的に破棄されると増加します。
enqueuedSequenceNumber	メッセージの元のシーケンス番号。 自動転送されたメッセージの場合、このプロパティは、最初に送信時点でメッセージに割り当てられたシーケンス番号を反映します。
enqueuedTimeUtc	メッセージが受け入れられ、Service Bus に格納された UTC インスタント。
expiresAtUtc	メッセージが削除対象としてマークされ、有効期限が原因でエンティティから取得できなくなった UTC インスタント。 このプロパティは、メッセージ上の他の 2 つのプロパティ ( enqueuedTimeUtc + timeToLive) から計算されます。
lockedUntilUtc	メッセージがキュー/サブスクリプションでロックされるまでの UTC インスタント。 ロックの有効期限が切れると、 deliveryCount がインクリメントされ、メッセージは再び取得できるようになります。 メッセージが receiveAndDelete 受信モードで受信された場合は適用されません。 モード。
lockToken	ロック・トークンは、 peekLock 受信モードでブローカーが保持しているロックへの参照です。 ロックは、製品ドキュメントで詳しく説明されているように、内部的にメッセージを解決するために使用されます メッセージが receiveAndDelete 受信モードで受信された場合は適用されません。 モード。
sequenceNumber	Service Bus によってメッセージに割り当てられた一意の番号。 シーケンス番号は、ブローカーによって受け入れられ、その真の識別子として機能するため、メッセージに割り当てられる一意の 64 ビット整数です。 パーティション分割されたエンティティの場合、最上位の 16 ビットはパーティション識別子を反映します。 シーケンス番号は単調に増加します。 48-64 ビット範囲が使い果たされると、0 にロールオーバーされます。 Javascriptが現在サポートしている最大安全整数は2^53 - 1です。 シーケンス番号は、最大 64 ビットの長さの AMQP Long タイプです。 名前のライブラリを使用していることを表すために long.js. お客様は、このライブラリによってエクスポートされた Long タイプを使用することを期待しています。
state	メッセージの状態は、アクティブ、遅延、またはスケジュールできます。 遅延メッセージには遅延状態があり、スケジュールされたメッセージはスケジュールされた状態で、他のすべてのメッセージはアクティブな状態です。

継承されたプロパティ

applicationProperties	カスタム メッセージ メタデータに使用できるアプリケーション固有のプロパティ。
body	送信する必要がある、または受信する必要があるメッセージ本文。 メッセージを受信するアプリケーションがこの SDK を使用していない場合は、言語間の互換性を向上させるために、本文ペイロードをバイト配列またはバッファーに変換します。
contentType	メッセージのコンテンツ タイプ。 必要に応じて、メッセージのペイロードを記述します。記述子は、"application/json" など、RFC2045セクション 5 の形式に従います。
correlationId	アプリケーションが関連付けの目的でメッセージのコンテキストを指定できるようにする関連付け識別子 。たとえば、応答先のメッセージの MessageId を反映します。 メッセージ ルーティングと相関 を参照してください。
messageId	メッセージ識別子は、メッセージとそのペイロードを一意に識別するアプリケーション定義の値です。 注: 整数ではない数値は使用できません。
partitionKey	パーティション分割されたエンティティにメッセージを送信するためのパーティション キー。 最大長は 128 文字です。 パーティション分割されたエンティティの場合、この値を設定すると、関連するメッセージを同じ内部パーティションに割り当てて、送信順序が正しく記録されるようにできます。 パーティションはこの値に対してハッシュ関数によって選択され、直接選択することはできません。 セッション対応エンティティの場合、sessionId プロパティはこの値をオーバーライドします。 パーティション分割されていないエンティティの場合、パーティション キーは無視されます
replyTo	返信を送信するエンティティのアドレス。 この省略可能な値とアプリケーション定義の値は、メッセージの受信者への応答パスを表す標準的な方法です。 送信者が応答を受け取ると、応答の送信先となるキューまたはトピックの絶対パスまたは相対パスに値が設定されます。 メッセージ ルーティングと相関 を参照してください。
replyToSessionId	replyTo アドレスを拡張するセッション識別子。 最大長は 128 文字です。 この値は ReplyTo 情報を拡張し、応答エンティティに送信されるときに応答に設定する必要がある SessionId を指定します。 メッセージ ルーティングと相関 を参照してください。
scheduledEnqueueTimeUtc	メッセージがエンキューされる日時 (UTC)。 このプロパティは UTC で時刻を返します。プロパティを設定する場合は、指定された DateTime 値も UTC である必要があります。 この値は、遅延メッセージ送信用です。 これは、今後特定の時刻に送信されるメッセージを遅延させるために使用されます。 メッセージのエンキュー時間は、メッセージが同時に送信されることを意味するものではありません。 エンキューされますが、実際の送信時間はキューのワークロードとその状態によって異なります。
sessionId	セッション対応エンティティのセッション識別子。 最大長は 128 文字です。 セッション対応エンティティの場合、このアプリケーション定義値はメッセージのセッション所属を指定します。 同じセッション識別子を持つメッセージは、要約ロックの対象となり、正確な順番での処理と多重分離が可能になります。 セッション非対応エンティティの場合、この値は無視されます。 メッセージ セッション。
subject	アプリケーション固有のラベル。 このプロパティを使用すると、アプリケーションは標準化された受信者にメッセージの目的を示します。 電子メールの件名行に似ています。 マップされた AMQP プロパティは "subject" です。
timeToLive	メッセージの Time to Live 値。 この値は、メッセージが期限切れになるまでの相対的な期間です。メッセージが受け入れられ、ブローカーによって格納された瞬間から始まり、enqueuedTimeUtcでキャプチャされます。 明示的に設定しない場合、想定される値はそれぞれのキューまたはトピックの DefaultTimeToLive です。 メッセージ レベルの timeToLive 値はエンティティの DefaultTimeToLive 設定より長くすることはできません。その場合は、自動的に調整されます。 有効期限 参照してください。
to	"宛先" アドレス。 このプロパティは、ルーティング シナリオで将来使用するために予約されており、現在、ブローカー自体では無視されます。 アプリケーションは、ルールドリブン 自動転送チェーン シナリオでこの値を使用して、メッセージの目的の論理宛先を示すことができます。

プロパティの詳細

deadLetterErrorDescription

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

deadLetterErrorDescription?: string

プロパティ値

string

deadLetterReason

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

deadLetterReason?: string

プロパティ値

string

deadLetterSource

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

deadLetterSource?: string

プロパティ値

string

deliveryCount

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

deliveryCount?: number

プロパティ値

number

enqueuedSequenceNumber

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

enqueuedSequenceNumber?: number

プロパティ値

number

enqueuedTimeUtc

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

enqueuedTimeUtc?: Date

プロパティ値

Date

expiresAtUtc

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

expiresAtUtc?: Date

プロパティ値

Date

lockedUntilUtc

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

• メッセージが receiveAndDelete 受信モードで受信された場合は適用されません。 モード。

lockedUntilUtc?: Date

プロパティ値

Date

lockToken

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

• メッセージが receiveAndDelete 受信モードで受信された場合は適用されません。 モード。

lockToken?: string

プロパティ値

string

sequenceNumber

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

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

sequenceNumber?: Long

プロパティ値

Long

state

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

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

プロパティ値

"active" | "deferred" | "scheduled"

継承されたプロパティの詳細

applicationProperties

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

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

プロパティ値

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

継承元ServiceBusMessage.applicationProperties

body

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

body: any

プロパティ値

any

ServiceBusMessage.bodyから継承

contentType

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

contentType?: string

プロパティ値

string

継承元ServiceBusMessage.contentType

correlationId

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

correlationId?: string | number | Buffer

プロパティ値

string | number | Buffer

継承元ServiceBusMessage.correlationId

messageId

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

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

messageId?: string | number | Buffer

プロパティ値

string | number | Buffer

継承元ServiceBusMessage.messageId

partitionKey

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

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

partitionKey?: string

プロパティ値

string

継承元ServiceBusMessage.partitionKey

replyTo

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

replyTo?: string

プロパティ値

string

継承元ServiceBusMessage.replyTo

replyToSessionId

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

replyToSessionId?: string

プロパティ値

string

継承元ServiceBusMessage.replyToSessionId

scheduledEnqueueTimeUtc

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

scheduledEnqueueTimeUtc?: Date

プロパティ値

Date

継承元ServiceBusMessage.scheduledEnqueueTimeUtc

sessionId

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

sessionId?: string

プロパティ値

string

継承元ServiceBusMessage.sessionId

subject

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

subject?: string

プロパティ値

string

継承元ServiceBusMessage.subject

timeToLive

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

timeToLive?: number

プロパティ値

number

継承元ServiceBusMessage.timeToLive

to

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

to?: string

プロパティ値

string

ServiceBusMessage.to から継承