次の方法で共有

ServiceBusMessage interface

  • リファレンス
パッケージ:
@azure/service-bus

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

プロパティ

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

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

プロパティの詳細

applicationProperties

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

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

プロパティ値

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

body

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

body: any

プロパティ値

any

contentType

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

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

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

timeToLive?: number

プロパティ値

number

to

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

to?: string

プロパティ値

string