ServiceBusReceivedMessage interface

套件:

@azure/service-bus

描述在查看作業期間從服務匯流排收到的訊息，因此無法解決。

Extends

ServiceBusMessage

屬性

deadLetterErrorDescription	無效訊息的錯誤描述。
deadLetterReason	導致訊息失效的原因。
deadLetterSource	佇列或訂用帳戶的名稱，在此訊息已排入佇列之前，訊息已失效。 只有在已寄不出的信件訊息中設定，然後從寄不出的信件子佇列自動轉寄到另一個實體。 指示其中訊息已成為無效信件的實體。
deliveryCount	針對此訊息嘗試進行的傳遞次數。 當訊息鎖定到期，或是使用 abandon() 訊息上的 方法明確放棄訊息時，計數就會遞增。
enqueuedSequenceNumber	訊息的原始序號。 對於已自動轉送的訊息，此屬性會反映訊息原始提交時首次指派給訊息的序號。
enqueuedTimeUtc	訊息已接受並儲存在服務匯流排中的 UTC 立即。
expiresAtUtc	由於到期而將訊息標示為移除且無法再從實體中擷取的 UTC 時刻。 這個屬性是從訊息上的 2 個其他屬性計算： enqueuedTimeUtc + timeToLive 。
lockedUntilUtc	UTC 立即，直到訊息保留在佇列/訂用帳戶中為止。 當鎖定到期時，會遞增 ， deliveryCount 而且訊息會再次可供擷取。 在接收模式中 receiveAndDelete 收到訊息時不適用。 模式。
lockToken	鎖定權杖是訊息代理程式在接收模式中 peekLock 保留之鎖定的參考。 鎖定會在內部解決訊息，如產品檔所述，更詳細地說明 在接收模式中 receiveAndDelete 收到訊息時不適用。 模式。
sequenceNumber	依服務匯流排指派給訊息的唯一號碼。 序號是指派給訊息的唯一 64 位元整數，會由訊息代理程式和函式所接收並儲存，以作為真正的識別碼。 對於分割的實體，最前面的 16 位元會反映分割區識別碼。 序號單調增加。 它們會在 48 - 64 位元範圍用盡時回復為 0。 JAVAscript 目前支援的最大安全整數為 2^53 - 1 。 序號是 AMQP Long 類型，長度最多可達 64 位。 為了表示我們使用名為 long.js的程式庫。 我們預期客戶會使用此 Long 程式庫匯出的類型。
state	訊息的狀態可以是作用中、延遲或排程。 延遲的訊息具有延後狀態、已排程的訊息具有排程狀態、所有其他訊息都有作用中狀態。

繼承的屬性

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

屬性詳細資料

deadLetterErrorDescription

無效訊息的錯誤描述。

deadLetterErrorDescription?: string

屬性值

string

deadLetterReason

導致訊息失效的原因。

deadLetterReason?: string

屬性值

string

deadLetterSource

佇列或訂用帳戶的名稱，在此訊息已排入佇列之前，訊息已失效。 只有在已寄不出的信件訊息中設定，然後從寄不出的信件子佇列自動轉寄到另一個實體。 指示其中訊息已成為無效信件的實體。

deadLetterSource?: string

屬性值

string

deliveryCount

針對此訊息嘗試進行的傳遞次數。 當訊息鎖定到期，或是使用 abandon() 訊息上的 方法明確放棄訊息時，計數就會遞增。

deliveryCount?: number

屬性值

number

enqueuedSequenceNumber

訊息的原始序號。 對於已自動轉送的訊息，此屬性會反映訊息原始提交時首次指派給訊息的序號。

enqueuedSequenceNumber?: number

屬性值

number

enqueuedTimeUtc

訊息已接受並儲存在服務匯流排中的 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

依服務匯流排指派給訊息的唯一號碼。 序號是指派給訊息的唯一 64 位元整數，會由訊息代理程式和函式所接收並儲存，以作為真正的識別碼。 對於分割的實體，最前面的 16 位元會反映分割區識別碼。 序號單調增加。 它們會在 48 - 64 位元範圍用盡時回復為 0。

JAVAscript 目前支援的最大安全整數為 2^53 - 1 。 序號是 AMQP Long 類型，長度最多可達 64 位。 為了表示我們使用名為 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，請將本文承載轉換成位元組陣列或 Buffer，以取得更佳的跨語言相容性。

body: any

屬性值

any

繼承自ServiceBusMessage.body

contentType

訊息的內容型別。 選擇性地描述訊息的承載，其描述項遵循 RFC2045 第 5 節的格式，例如「application/json」。

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

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

subject?: string

屬性值

string

繼承自ServiceBusMessage.subject

timeToLive

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

timeToLive?: number

屬性值

number

繼承自ServiceBusMessage.timeToLive

to

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

to?: string

屬性值

string

繼承自ServiceBusMessage.to