ServiceBusMessage interface

套件:

@azure/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	應用程式專用標籤。 此屬性可讓應用程式在標準化中向接收者指出訊息的目的。 fashion，類似于電子郵件主旨行。 對應的 AMQP 屬性為 「subject」。
timeToLive	訊息即時值的時間。 這個值是訊息到期的相對持續時間，從訊息被訊息接受並儲存的立即開始，如 中所 enqueuedTimeUtc 擷取。 未明確設定時，所使用的值便是對應佇列或主題的 DefaultTimeToLive。 訊息層級 timeToLive 值不能超過實體的 DefaultTimeToLive 設定，而且如果這麼做，則會以無訊息方式調整。 請參閱 到期日。
to	「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

應用程式專用標籤。 此屬性可讓應用程式在標準化中向接收者指出訊息的目的。 fashion，類似于電子郵件主旨行。 對應的 AMQP 屬性為 「subject」。

subject?: string

屬性值

string

timeToLive

訊息即時值的時間。 這個值是訊息到期的相對持續時間，從訊息被訊息接受並儲存的立即開始，如 中所 enqueuedTimeUtc 擷取。 未明確設定時，所使用的值便是對應佇列或主題的 DefaultTimeToLive。 訊息層級 timeToLive 值不能超過實體的 DefaultTimeToLive 設定，而且如果這麼做，則會以無訊息方式調整。 請參閱 到期日。

timeToLive?: number

屬性值

number

to

「to」 位址。 這個屬性乃是保留以供日後路由傳送案例使用，訊息代理程式目前會忽略這個屬性。 應用程式可以在規則驅動的 自動轉寄鏈結 案例中使用此值，以指出訊息的預期邏輯目的地。

to?: string

屬性值

string