列舉型別
「探索」作業可瀏覽階層式命名空間,而「列舉」作業則可讓您以條列式檢視列出特定種類的所有實體。 列舉會針對位於服務命名空間根目錄的特殊保留資源集合 ($Resources) 執行。 就功能而言,列舉作業的發生與集合位址有關;例如,“/subscriptions” 或 “/rules” 適用於主題的訂閱或規則。
要求
您可以如下建構「列舉」要求。
方法 | 要求 URI | HTTP 版本 |
---|---|---|
GET | HTTPs://{serviceNamespace}.servicebus.windows.net/$Resources/{resourceCollection} 或 HTTPs://{serviceNamespace}.servicebus.windows.net/{path}/Subscriptions 或 HTTPs://{serviceNamespace}.servicebus.windows.net/{path}/Subscriptions/{subscription-name}/rules |
HTTP/1.1 |
查詢參數$skip和$top
列舉支援分頁。 您可以在服務命名空間下擷取一系列實體。 查詢參數$skip指出傳回列舉時,要求應該略過的專案數,並$top應該傳回多少個專案。
要求標頭
下表描述必要的和選用的要求標頭。
要求標頭 | 描述 |
---|---|
授權 | 指定具有「管理」許可權的共用存取簽章 (SAS) 權杖。 如需詳細資訊 ,請參閱使用共用存取簽章的服務匯流排驗證 。 |
要求本文
無。
回應
回應包括 HTTP 狀態碼和一組回應標頭。
回應碼
程式碼 | 描述 |
---|---|
200 | 正常。 |
401 | 未經授權。 要求未經授權。 |
注意
如果沒有任何實體存在,則會傳回空的摘要。
如需狀態碼的相關資訊,請參閱 狀態和錯誤碼。
回應標頭
這項作業的回應包括下列標頭。 回應也可能包括其他標準 HTTP 標頭。 所有標準標頭都符合 HTTP/1.1 通訊協定規格。
回應標頭 | Description |
---|---|
Content-type | Content-Type:application/atom+xml;type=entry |
回應本文
成功時,會傳回含有多個 Atom 項目的 Atom 摘要,以列出指定命名空間中指定類型的所有可用資源。 例如:
<?xml version="1.0" encoding="utf-8" ?>
<feed xmlns='http://www.w3.org/2005/Atom'>
<entry>
<id>https://{serviceNamespace}.Windows.net/{path}</id>
<published>{createdTime}</published>
<updated>{lastUpdatedTime}</updated>
<link rel='self'>https://{serviceNamespace}.servicebus.Windows.net/{path}</link>
<content type='application/xml'>
{description}
</content>
</entry>
</feed>
如需 {description} 元素的可能內容,請參閱 概觀。