QueueProperties interface

套件:

@azure/service-bus

表示 updateQueue 的輸入。

屬性

authorizationRules	佇列上的授權規則
autoDeleteOnIdle	刪除實體之前的空閒時間上限。 這是以 ISO-8601 持續時間格式指定，例如 “PT1M” 為 1 分鐘，“PT5S” 為 5 秒。 ISO-8601 持續時間格式的詳細資訊：https://en.wikipedia.org/wiki/ISO_8601#Durations
availabilityStatus	傳訊實體的可用性狀態。
deadLetteringOnMessageExpiration	如果啟用訊息且訊息過期，服務總線會將訊息從佇列移至佇列的寄不出的信件子佇列。 如果停用，訊息將會從佇列永久刪除。 只能在佇列建立時設定。
defaultMessageTimeToLive	視是否啟用 DeadLettering 而定，如果訊息儲存在佇列中超過指定時間，就會自動移至寄不出的信件子佇列或刪除。 只有在訊息 TTL 小於佇列上設定的 TTL 時，才會覆寫此值。 建立佇列之後，這個值是不可變的。 這是以 ISO-8601 持續時間格式指定，例如 “PT1M” 為 1 分鐘，“PT5S” 為 5 秒。 ISO-8601 持續時間格式的詳細資訊：https://en.wikipedia.org/wiki/ISO_8601#Durations
duplicateDetectionHistoryTimeWindow	指定服務總線偵測訊息重複的時間範圍。 這是以 ISO-8601 持續時間格式指定，例如 “PT1M” 為 1 分鐘，“PT5S” 為 5 秒。 ISO-8601 持續時間格式的詳細資訊：https://en.wikipedia.org/wiki/ISO_8601#Durations
enableBatchedOperations	指定是否應該允許批次作業。
enableExpress	指定是否在佇列上啟用快速實體。
enablePartitioning	指定佇列是否應該分割。
forwardDeadLetteredMessagesTo	要轉寄寄不出的訊息的佇列或主題的絕對 URL 或主題名稱。 例如，絕對 URL 輸入會是窗體 sb://<your-service-bus-namespace-endpoint>/<queue-or-topic-name>
forwardTo	要轉送訊息的佇列或主題名稱或絕對URL。 例如，絕對 URL 輸入會是窗體 sb://<your-service-bus-namespace-endpoint>/<queue-or-topic-name>
lockDuration	決定訊息應鎖定以供接收者處理的時間量，以秒為單位。 在此期間之後，訊息會解除鎖定，可供下一個接收者取用。 （如果啟用會話，此鎖定持續時間適用於會話，不適用於訊息。 這是以 ISO-8601 持續時間格式指定，例如 “PT1M” 為 1 分鐘，“PT5S” 為 5 秒。 ISO-8601 持續時間格式的詳細資訊：https://en.wikipedia.org/wiki/ISO_8601#Durations
maxDeliveryCount	訊息的傳遞計數上限，如果訊息仍未解決，則會移至寄不出的信件子佇列。
maxMessageSizeInKilobytes	傳送至此佇列之訊息的最大訊息大小，以 KB 為單位。 如果建立 ServiceBusAdministrationClient時，選擇服務版本 「2017-04」 不適用。
maxSizeInMegabytes	指定以 MB 為單位的佇列大小上限。 任何嘗試加入佇列會導致佇列超過此值的訊息都會失敗。
name	佇列的名稱
requiresDuplicateDetection	如果啟用，主題會在 DuplicateDetectionHistoryTimeWindow 屬性所指定的時間範圍內偵測重複的訊息。 只能在佇列建立時設定。
requiresSession	如果設定為 true，佇列將會是會話感知，且僅支援 SessionReceiver。 透過 REST 不支援會話感知佇列。 只能在佇列建立時設定。
status	傳訊實體的狀態。
userMetadata	使用者提供了與佇列相關聯的元數據資訊。 用來指定文字內容，例如標籤、標籤等。值不得超過以 utf-8 編碼的 1024 個字節。

屬性詳細資料

authorizationRules

佇列上的授權規則

authorizationRules?: AuthorizationRule[]

屬性值

AuthorizationRule[]

autoDeleteOnIdle

刪除實體之前的空閒時間上限。 這是以 ISO-8601 持續時間格式指定，例如 “PT1M” 為 1 分鐘，“PT5S” 為 5 秒。

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

autoDeleteOnIdle: string

屬性值

string

availabilityStatus

傳訊實體的可用性狀態。

availabilityStatus: EntityAvailabilityStatus

屬性值

EntityAvailabilityStatus

deadLetteringOnMessageExpiration

如果啟用訊息且訊息過期，服務總線會將訊息從佇列移至佇列的寄不出的信件子佇列。 如果停用，訊息將會從佇列永久刪除。 只能在佇列建立時設定。

deadLetteringOnMessageExpiration: boolean

屬性值

boolean

defaultMessageTimeToLive

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

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

defaultMessageTimeToLive: string

屬性值

string

duplicateDetectionHistoryTimeWindow

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

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

duplicateDetectionHistoryTimeWindow: string

屬性值

string

enableBatchedOperations

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

enableBatchedOperations: boolean

屬性值

boolean

enableExpress

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

enableExpress: boolean

屬性值

boolean

enablePartitioning

指定佇列是否應該分割。

enablePartitioning: boolean

屬性值

boolean

forwardDeadLetteredMessagesTo

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

forwardDeadLetteredMessagesTo?: string

屬性值

string

forwardTo

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

forwardTo?: string

屬性值

string

lockDuration

決定訊息應鎖定以供接收者處理的時間量，以秒為單位。 在此期間之後，訊息會解除鎖定，可供下一個接收者取用。 （如果啟用會話，此鎖定持續時間適用於會話，不適用於訊息。

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

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

lockDuration: string

屬性值

string

maxDeliveryCount

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

maxDeliveryCount: number

屬性值

number

maxMessageSizeInKilobytes

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

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

maxMessageSizeInKilobytes?: number

屬性值

number

maxSizeInMegabytes

指定以 MB 為單位的佇列大小上限。 任何嘗試加入佇列會導致佇列超過此值的訊息都會失敗。

maxSizeInMegabytes: number

屬性值

number

name

佇列的名稱

name: string

屬性值

string

requiresDuplicateDetection

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

requiresDuplicateDetection: boolean

屬性值

boolean

requiresSession

如果設定為 true，佇列將會是會話感知，且僅支援 SessionReceiver。 透過 REST 不支援會話感知佇列。 只能在佇列建立時設定。

requiresSession: boolean

屬性值

boolean

status

傳訊實體的狀態。

status: EntityStatus

屬性值

EntityStatus

userMetadata

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

userMetadata: string

屬性值

string