ServiceBusMessage interface

套件:

@azure/service-bus

描述要傳送至服務總線的訊息。

屬性

applicationProperties	可用於自定義訊息元數據的應用程式特定屬性。
body	需要傳送或接收的訊息本文。 如果接收訊息的應用程式未使用此 SDK，請將本文承載轉換為位元組陣列或 Buffer，以取得更佳的跨語言相容性。
contentType	訊息的內容類型。 選擇性地描述訊息的承載，其描述項會遵循第 5 節RFC2045的格式，例如“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

訊息的內容類型。 選擇性地描述訊息的承載，其描述項會遵循第 5 節RFC2045的格式，例如“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