TopicProperties interface

套件:

@azure/service-bus

表示 updateTopic 的輸入。

屬性

authorizationRules	主題的授權規則
autoDeleteOnIdle	刪除實體之前的空閒時間上限。 這是以 ISO-8601 持續時間格式指定，例如 “PT1M” 為 1 分鐘，“PT5S” 為 5 秒。 ISO-8601 持續時間格式的詳細資訊：https://en.wikipedia.org/wiki/ISO_8601#Durations
availabilityStatus	傳訊實體的可用性狀態。
defaultMessageTimeToLive	決定訊息在相關聯的訂用帳戶中存多久時間。 除非訂閱是使用較小的TTL明確建立，否則訂閱會繼承主題中的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	指定主題是否應該分割
maxMessageSizeInKilobytes	傳送至此佇列/主題之訊息的最大訊息大小，以 KB 為單位。 如果建立 ServiceBusAdministrationClient時，選擇服務版本 「2017-04」 不適用。
maxSizeInMegabytes	指定以 MB 為單位的主題大小上限。 任何將會導致主題超過此值的訊息加入佇列時，都會失敗。 儲存在主題或任何訂用帳戶中的訊息都會計入此值。 一或多個訂用帳戶中訊息的多個複本會計算為單一訊息。 例如，如果訊息 m 存在於訂用帳戶 s1 中，而訂用帳戶 s2 中有兩次，則 m 會計算為單一訊息。
name	主題的名稱
requiresDuplicateDetection	如果啟用，主題會在 DuplicateDetectionHistoryTimeWindow 屬性所指定的時間範圍內偵測重複的訊息。 只有在主題建立時間才可設定。
status	傳訊實體的狀態。
supportOrdering	指定主題是否支援訊息排序。
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

defaultMessageTimeToLive

決定訊息在相關聯的訂用帳戶中存多久時間。 除非訂閱是使用較小的TTL明確建立，否則訂閱會繼承主題中的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

maxMessageSizeInKilobytes

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

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

maxMessageSizeInKilobytes?: number

屬性值

number

maxSizeInMegabytes

指定以 MB 為單位的主題大小上限。 任何將會導致主題超過此值的訊息加入佇列時，都會失敗。 儲存在主題或任何訂用帳戶中的訊息都會計入此值。 一或多個訂用帳戶中訊息的多個複本會計算為單一訊息。 例如，如果訊息 m 存在於訂用帳戶 s1 中，而訂用帳戶 s2 中有兩次，則 m 會計算為單一訊息。

maxSizeInMegabytes: number

屬性值

number

name

主題的名稱

name: string

屬性值

string

requiresDuplicateDetection

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

requiresDuplicateDetection: boolean

屬性值

boolean

status

傳訊實體的狀態。

status: EntityStatus

屬性值

EntityStatus

supportOrdering

指定主題是否支援訊息排序。

supportOrdering: boolean

屬性值

boolean

userMetadata

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

userMetadata: string

屬性值

string