共用方式為


CreateSubscriptionOptions interface

表示訂用帳戶上的可設定選項

Extends

屬性

autoDeleteOnIdle

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

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

availabilityStatus

傳訊實體的可用性狀態。

deadLetteringOnFilterEvaluationExceptions

決定服務總線如何處理在訂用帳戶篩選評估期間造成例外狀況的訊息。 如果值設定為 true,造成例外狀況的訊息將會移至訂用帳戶的寄不出的信件子佇列。 否則,將會捨棄它。 根據預設,此參數會設定為 true,讓用戶有機會調查例外狀況的原因。 它可能發生於格式錯誤的訊息,或訊息格式的篩選中所做的一些不正確假設。 只有在主題建立時間才可設定。

deadLetteringOnMessageExpiration

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

defaultMessageTimeToLive

決定訊息存留在訂用帳戶中的時間長度。 根據是否啟用寄不出的信件,TTL 已過期的訊息會移至訂用帳戶的相關聯 DeadLtterQueue 或永久刪除。 這是以 ISO-8601 持續時間格式指定,例如 “PT1M” 為 1 分鐘,“PT5S” 為 5 秒。

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

defaultRuleOptions

表示建立訂用帳戶默認規則的選項。

enableBatchedOperations

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

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

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

requiresSession

如果設定為 true,則訂用帳戶會是會話感知,且僅支援 SessionReceiver。 透過 REST 不支援會話感知訂用帳戶。 只能在訂用帳戶建立時設定。

status

傳訊實體的狀態。

userMetadata

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

繼承的屬性

abortSignal

可用來中止要求的訊號。

onResponse

每次從伺服器收到回應時,要呼叫的函式,同時執行要求的作業。 可以多次呼叫。

requestOptions

建立和傳送此作業之 HTTP 要求時所使用的選項。

serializerOptions

覆寫串行化/取消串行化行為的選項。

tracingOptions

啟用追蹤時所使用的選項。

屬性詳細資料

autoDeleteOnIdle

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

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

autoDeleteOnIdle?: string

屬性值

string

availabilityStatus

傳訊實體的可用性狀態。

availabilityStatus?: EntityAvailabilityStatus

屬性值

deadLetteringOnFilterEvaluationExceptions

決定服務總線如何處理在訂用帳戶篩選評估期間造成例外狀況的訊息。 如果值設定為 true,造成例外狀況的訊息將會移至訂用帳戶的寄不出的信件子佇列。 否則,將會捨棄它。 根據預設,此參數會設定為 true,讓用戶有機會調查例外狀況的原因。 它可能發生於格式錯誤的訊息,或訊息格式的篩選中所做的一些不正確假設。 只有在主題建立時間才可設定。

deadLetteringOnFilterEvaluationExceptions?: boolean

屬性值

boolean

deadLetteringOnMessageExpiration

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

deadLetteringOnMessageExpiration?: boolean

屬性值

boolean

defaultMessageTimeToLive

決定訊息存留在訂用帳戶中的時間長度。 根據是否啟用寄不出的信件,TTL 已過期的訊息會移至訂用帳戶的相關聯 DeadLtterQueue 或永久刪除。 這是以 ISO-8601 持續時間格式指定,例如 “PT1M” 為 1 分鐘,“PT5S” 為 5 秒。

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

defaultMessageTimeToLive?: string

屬性值

string

defaultRuleOptions

表示建立訂用帳戶默認規則的選項。

defaultRuleOptions?: { action?: SqlRuleAction, filter?: CorrelationRuleFilter | SqlRuleFilter, name: string }

屬性值

{ action?: SqlRuleAction, filter?: CorrelationRuleFilter | SqlRuleFilter, name: string }

enableBatchedOperations

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

enableBatchedOperations?: 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

requiresSession

如果設定為 true,則訂用帳戶會是會話感知,且僅支援 SessionReceiver。 透過 REST 不支援會話感知訂用帳戶。 只能在訂用帳戶建立時設定。

requiresSession?: boolean

屬性值

boolean

status

傳訊實體的狀態。

status?: EntityStatus

屬性值

userMetadata

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

userMetadata?: string

屬性值

string

繼承的屬性詳細資料

abortSignal

可用來中止要求的訊號。

abortSignal?: AbortSignalLike

屬性值

繼承自OperationOptions.abortSignal

onResponse

每次從伺服器收到回應時,要呼叫的函式,同時執行要求的作業。 可以多次呼叫。

onResponse?: RawResponseCallback

屬性值

繼承自OperationOptions.onResponse

requestOptions

建立和傳送此作業之 HTTP 要求時所使用的選項。

requestOptions?: OperationRequestOptions

屬性值

繼承自operationOptions.requestOptions

serializerOptions

覆寫串行化/取消串行化行為的選項。

serializerOptions?: SerializerOptions

屬性值

繼承自OperationOptions.serializerOptions

tracingOptions

啟用追蹤時所使用的選項。

tracingOptions?: OperationTracingOptions

屬性值

繼承自OperationOptions.tracingOptions