重要
自 2021 年 11 月 1 日起，此 API 已過時且已淘汰，不應再使用。
匯報 佇列描述，並將更新狀態傳送至 FE/BE 以更新對應的 DB 專案。
要求
| 方法 | 要求 URI | HTTP 版本 |
|---|---|---|
| PUT | https://management.core.windows.net/{subscription ID}/services/ServiceBus/Namespaces/{Namespace}/Queues/{Queue Path} | HTTP/1.1 |
要求標頭
下表描述必要的和選用的要求標頭。
| 要求標頭 | 描述 |
|---|---|
| Content-Type | application/xml;type=entry;charset=utf-8 |
| If-Match | * |
| x-ms-version | 2012-03-01 |
要求也需要客戶端憑證。 此憑證必須符合您針對該特殊訂閱所上傳的憑證。
要求本文
下表說明要求主體的重要元素。 您只能更新這些屬性。 即使您只是變更一個屬性，本文也必須包含完整的佇列描述。 建議的流程如下：
取得佇列描述。
更新必要的元素。
傳入更新的描述。
| 屬性名稱 | 類型 | Description |
|---|---|---|
| authorizationRules | AuthorizationRule[] | 授權規則的陣列。 |
| autoDeleteOnIdle | 字串 | 指出實體在特定時間閑置時是否要自動刪除。 |
| deadLetteringOnMessageExpiration | Boolean | 只能在佇列建立期間進行設定。 - 預設值：False。 此欄位會控管服務總線如何處理已過期 TTL 的訊息。 如果 為 true 且訊息過期，服務總線會將訊息從佇列移至佇列的寄不出的信件子佇列。 如果 為 false，則會從佇列永久刪除訊息。 |
| defaultMessageTtl | XML 日期時間 | 根據是否啟用寄不出的信件功能，如果訊息已儲存在佇列中超過指定時間，它就會自動移至寄不出的信件佇列或刪除。 只有在訊息 TTL 小於佇列上設定的 TTL 時，此值才會覆寫為訊息中指定的 TTL。 建立佇列之後，此值就會永遠不變： - 範圍：1 秒 – 14 天。 - 預設值：14 天。 |
| duplicateDetectionHistoryTimeWindow | 時間範圍 | 屬性，指定服務總線偵測到訊息重複的時間範圍。 - 範圍：1 秒–7 天。 - 預設值：10 分鐘。 |
| enableBatchedOperations | Boolean | 指出您是否要啟用批處理作業。 |
| forwardDeadLetteredMessagesTo | 字串 | 指定要轉寄不出的信件訊息的位置。 |
| forwardTo | 字串 | 指定要轉送訊息的位置。 |
| lockDuration | XML 日期時間 | 此設定會決定應鎖定訊息以供接收者處理的時間量 (秒)。 在此期間之後，系統會將訊息解除鎖定，並供下一個接收者使用。 只能在佇列建立期間進行設定： - 範圍：0-5 分鐘。0 表示訊息未鎖定。 - 預設值：30 秒。 |
| maxDeliveryCount | 不帶正負號的整數 | 服務總線嘗試在寄不出的信件或捨棄之前傳遞訊息的次數上限。 預設值為 10。 |
| maxSizeInMegabytes | 不帶正負號的整數 | 以 MB 為單位的大小上限。 |
| status | EntityStatus | 實體的狀態。 |
| userMetadata | 字串 | 用戶元數據。 |
這些屬性無法更新： requireSession、 requiresDuplicateDetection、 enablePartitioning和 name。
回應
回應包括 HTTP 狀態碼和一組回應標頭。
回應碼
注意
如果您建立名稱包含特殊或編碼字元的佇列 (，例如「test？Name=value&“，其會編碼為 ”test%3FName%3Dvalue%26“) ，將會產生 (401) 未經授權的例外狀況。
| 程式碼 | 描述 |
|---|---|
| 200 | 已成功更新佇列描述。 |
| 401 | 授權失敗。 |
| 404 | 此命名空間下不存在實體。 |
| 500 | 內部錯誤。 |
如需狀態代碼的相關信息，請參閱 狀態和錯誤碼。
回應標頭
無。
回應本文
無。