SBQueue interface
佇列資源的描述。
- Extends
屬性
accessed |
上次傳送訊息的時間,或上次收到此佇列的要求。 注意:這個屬性不會串行化。 它只能由伺服器填入。 |
auto |
ISO 8061 timeSpan 閑置間隔之後,佇列會自動刪除。 持續時間下限為 5 分鐘。 |
count |
訊息計數詳細數據。 注意:這個屬性不會串行化。 它只能由伺服器填入。 |
created |
建立訊息的確切時間。 注意:這個屬性不會串行化。 它只能由伺服器填入。 |
dead |
值,指出當訊息到期時,這個佇列是否具有寄不出的信件支援。 |
default |
ISO 8601 預設訊息時間範圍到即時值。 這是訊息到期的持續時間,從訊息傳送至服務總線時開始。 這是當 TimeToLive 未在訊息本身上設定時所使用的預設值。 |
duplicate |
定義重複偵測歷程記錄持續時間的 ISO 8601 timeSpan 結構。 預設值為 10 分鐘。 |
enable |
值,指出是否啟用伺服器端批次作業。 |
enable |
值,指出是否啟用 Express Entities。 快速佇列會在將訊息寫入永續性記憶體之前,暫時將訊息儲存在記憶體中。 |
enable |
值,指出佇列是否要跨多個訊息代理程序進行分割。 |
forward |
轉寄寄不出的信件訊息的佇列/主題名稱 |
forward |
要轉送訊息的佇列/主題名稱 |
lock |
預覽鎖定的 ISO 8601 時間範圍持續時間;也就是說,訊息鎖定給其他接收者的時間量。 LockDuration 的最大值為 5 分鐘;預設值為1分鐘。 |
max |
傳遞計數上限。 在傳遞次數之後,會自動死電訊息。 預設值為 10。 |
max |
佇列可接受之訊息承載的大小上限(以 KB 為單位)。 這個屬性目前只會在 Premium 中使用,預設值為 1024。 |
max |
佇列的大小上限,以 MB 為單位,這是為佇列配置的記憶體大小。 預設值為 1024。 |
message |
佇列中的訊息數目。 注意:這個屬性不會串行化。 它只能由伺服器填入。 |
requires |
值,指出此佇列是否需要重複偵測。 |
requires |
值,指出佇列是否支援會話的概念。 |
size |
佇列的大小,以位元組為單位。 注意:這個屬性不會串行化。 它只能由伺服器填入。 |
status | 列舉傳訊實體狀態的可能值。 |
system |
與此資源相關的系統元數據。 注意:這個屬性不會串行化。 它只能由伺服器填入。 |
updated |
訊息更新的確切時間。 注意:這個屬性不會串行化。 它只能由伺服器填入。 |
繼承的屬性
id | 資源的完整資源標識碼。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} 注意:此屬性將不會串行化。 它只能由伺服器填入。 |
location | 資源所在的地理位置注意:此屬性將不會串行化。 它只能由伺服器填入。 |
name | 資源名稱注意:此屬性將不會串行化。 它只能由伺服器填入。 |
type | 資源的型別。 例如“Microsoft.EventHub/Namespaces” 或 “Microsoft.EventHub/Namespaces/EventHubs” 附注:此屬性將不會串行化。 它只能由伺服器填入。 |
屬性詳細資料
accessedAt
上次傳送訊息的時間,或上次收到此佇列的要求。 注意:這個屬性不會串行化。 它只能由伺服器填入。
accessedAt?: Date
屬性值
Date
autoDeleteOnIdle
ISO 8061 timeSpan 閑置間隔之後,佇列會自動刪除。 持續時間下限為 5 分鐘。
autoDeleteOnIdle?: string
屬性值
string
countDetails
createdAt
建立訊息的確切時間。 注意:這個屬性不會串行化。 它只能由伺服器填入。
createdAt?: Date
屬性值
Date
deadLetteringOnMessageExpiration
值,指出當訊息到期時,這個佇列是否具有寄不出的信件支援。
deadLetteringOnMessageExpiration?: boolean
屬性值
boolean
defaultMessageTimeToLive
ISO 8601 預設訊息時間範圍到即時值。 這是訊息到期的持續時間,從訊息傳送至服務總線時開始。 這是當 TimeToLive 未在訊息本身上設定時所使用的預設值。
defaultMessageTimeToLive?: string
屬性值
string
duplicateDetectionHistoryTimeWindow
定義重複偵測歷程記錄持續時間的 ISO 8601 timeSpan 結構。 預設值為 10 分鐘。
duplicateDetectionHistoryTimeWindow?: string
屬性值
string
enableBatchedOperations
值,指出是否啟用伺服器端批次作業。
enableBatchedOperations?: boolean
屬性值
boolean
enableExpress
值,指出是否啟用 Express Entities。 快速佇列會在將訊息寫入永續性記憶體之前,暫時將訊息儲存在記憶體中。
enableExpress?: boolean
屬性值
boolean
enablePartitioning
值,指出佇列是否要跨多個訊息代理程序進行分割。
enablePartitioning?: boolean
屬性值
boolean
forwardDeadLetteredMessagesTo
轉寄寄不出的信件訊息的佇列/主題名稱
forwardDeadLetteredMessagesTo?: string
屬性值
string
forwardTo
要轉送訊息的佇列/主題名稱
forwardTo?: string
屬性值
string
lockDuration
預覽鎖定的 ISO 8601 時間範圍持續時間;也就是說,訊息鎖定給其他接收者的時間量。 LockDuration 的最大值為 5 分鐘;預設值為1分鐘。
lockDuration?: string
屬性值
string
maxDeliveryCount
傳遞計數上限。 在傳遞次數之後,會自動死電訊息。 預設值為 10。
maxDeliveryCount?: number
屬性值
number
maxMessageSizeInKilobytes
佇列可接受之訊息承載的大小上限(以 KB 為單位)。 這個屬性目前只會在 Premium 中使用,預設值為 1024。
maxMessageSizeInKilobytes?: number
屬性值
number
maxSizeInMegabytes
佇列的大小上限,以 MB 為單位,這是為佇列配置的記憶體大小。 預設值為 1024。
maxSizeInMegabytes?: number
屬性值
number
messageCount
佇列中的訊息數目。 注意:這個屬性不會串行化。 它只能由伺服器填入。
messageCount?: number
屬性值
number
requiresDuplicateDetection
值,指出此佇列是否需要重複偵測。
requiresDuplicateDetection?: boolean
屬性值
boolean
requiresSession
值,指出佇列是否支援會話的概念。
requiresSession?: boolean
屬性值
boolean
sizeInBytes
佇列的大小,以位元組為單位。 注意:這個屬性不會串行化。 它只能由伺服器填入。
sizeInBytes?: number
屬性值
number
status
systemData
updatedAt
訊息更新的確切時間。 注意:這個屬性不會串行化。 它只能由伺服器填入。
updatedAt?: Date
屬性值
Date
繼承的屬性詳細資料
id
資源的完整資源標識碼。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} 注意:此屬性將不會串行化。 它只能由伺服器填入。
id?: string
屬性值
string
location
name
type
資源的型別。 例如“Microsoft.EventHub/Namespaces” 或 “Microsoft.EventHub/Namespaces/EventHubs” 附注:此屬性將不會串行化。 它只能由伺服器填入。
type?: string
屬性值
string