ServiceBusMessage interface

パッケージ:

@azure/service-bus

Service Bus に送信するメッセージについて説明します。

プロパティ

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

プロパティの詳細

applicationProperties

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

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

プロパティ値

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

body

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

body: any

プロパティ値

any

contentType

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

contentType?: string

プロパティ値

string

correlationId

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

correlationId?: string | number | Buffer

プロパティ値

string | number | Buffer

messageId

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

注: 整数以外の数値は使用できません。

messageId?: string | number | Buffer

プロパティ値

string | number | Buffer

partitionKey

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

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

partitionKey?: string

プロパティ値

string

replyTo

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

replyTo?: string

プロパティ値

string

replyToSessionId

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

replyToSessionId?: string

プロパティ値

string

scheduledEnqueueTimeUtc

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

scheduledEnqueueTimeUtc?: Date

プロパティ値

Date

sessionId

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

sessionId?: string

プロパティ値

string

subject

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

subject?: string

プロパティ値

string

timeToLive

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

timeToLive?: number

プロパティ値

number

to

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

to?: string

プロパティ値

string