QueueProperties interface

佇列上的授權規則

authorizationRules?: AuthorizationRule[]

屬性值

刪除實體之前的最大閒置時間。 這是以 ISO-8601 持續時間格式指定，例如 「PT1M」 1 分鐘，「PT5S」 為 5 秒。

ISO-8601 持續時間格式的詳細資訊： https://en.wikipedia.org/wiki/ISO_8601#Durations

autoDeleteOnIdle: string

屬性值

傳訊實體的可用性狀態。

availabilityStatus: EntityAvailabilityStatus

屬性值

如果已啟用且訊息過期，服務匯流排會將訊息從佇列移至佇列的寄不出的信件子佇列。 如果停用，訊息將會從佇列永久刪除。 只能在佇列建立期間進行設定。

deadLetteringOnMessageExpiration: boolean

屬性值

根據是否啟用 DeadLettering，如果訊息已儲存在佇列中超過指定時間，則訊息會自動移至寄不出的信件子佇列或刪除。 只有在訊息 TTL 小於佇列上設定的 TTL 時，此值才會覆寫為訊息中指定的 TTL。 建立佇列之後，這個值是不可變的。 這是以 ISO-8601 持續時間格式指定，例如 「PT1M」 1 分鐘，「PT5S」 為 5 秒。

ISO-8601 持續時間格式的詳細資訊： https://en.wikipedia.org/wiki/ISO_8601#Durations

defaultMessageTimeToLive: string

屬性值

指定服務匯流排偵測訊息重複的時間範圍。 這是以 ISO-8601 持續時間格式指定，例如 「PT1M」 1 分鐘，「PT5S」 為 5 秒。

ISO-8601 持續時間格式的詳細資訊： https://en.wikipedia.org/wiki/ISO_8601#Durations

duplicateDetectionHistoryTimeWindow: string

屬性值

指定是否應該允許批次作業。

enableBatchedOperations: boolean

屬性值

指定是否在佇列上啟用快速實體。

enableExpress: boolean

屬性值

指定佇列是否應該分割。

enablePartitioning: boolean

屬性值

要轉寄寄不出的訊息之佇列或主題的絕對 URL 或主題名稱。 例如，絕對 URL 輸入會是表單 sb://<your-service-bus-namespace-endpoint>/<queue-or-topic-name>

forwardDeadLetteredMessagesTo?: string

屬性值

要轉送訊息的佇列或主題名稱或絕對 URL。 例如，絕對 URL 輸入會是表單 sb://<your-service-bus-namespace-endpoint>/<queue-or-topic-name>

forwardTo?: string

屬性值

決定應該鎖定訊息以供接收者處理的時間量 (秒)。 在此期間之後，系統會將訊息解除鎖定，並供下一個接收者使用。 (如果已啟用會話，此鎖定持續時間適用于會話，不適用於 messages。)

這是以 ISO-8601 持續時間格式指定，例如 「PT1M」 1 分鐘，「PT5S」 為 5 秒。

ISO-8601 持續時間格式的詳細資訊： https://en.wikipedia.org/wiki/ISO_8601#Durations

lockDuration: string

屬性值

訊息的傳遞計數上限，如果訊息仍然未結算，則會移至寄不出的信件子佇列。

maxDeliveryCount: number

屬性值

傳送至此佇列之訊息的最大訊息大小，以 KB 為單位。

如果在建立 ServiceBusAdministrationClient 時選擇服務版本 「2017-04」，則不適用。

maxMessageSizeInKilobytes?: number

屬性值

指定佇列大小上限，以 MB 為單位。 任何對於將訊息放入佇列而導致佇列超過此值的嘗試都將失敗。

maxSizeInMegabytes: number

屬性值

佇列的名稱

name: string

屬性值

如果啟用，主題會在 DuplicateDetectionHistoryTimeWindow 屬性所指定的時間範圍內偵測重複的訊息。 只能在佇列建立期間進行設定。

requiresDuplicateDetection: boolean

屬性值

如果設定為 true，佇列將會是會話感知，且僅支援 SessionReceiver。 不支援透過 REST 的工作階段感知佇列。 只能在佇列建立期間進行設定。

requiresSession: boolean

屬性值

傳訊實體的狀態。

status: EntityStatus

屬性值

使用者提供了與佇列相關聯的中繼資料資訊。 用來指定文字內容，例如標籤、標籤等。值不得超過以 utf-8 編碼的 1024 個位元組。

userMetadata: string

屬性值