列挙

[アーティクル]
08/04/2023

Discovery 操作は階層構造の名前空間に移動しますが、Enumeration では特定の種類のすべてのエンティティをフラットビューで一覧表示できます。列挙は、サービス名前空間のルートにある特別な予約済みリソースコレクション ($Resources) に対して実行されます。機能的に、列挙は、コレクションのアドレスに対して行われます。たとえば、トピックのサブスクリプションやルールの “/subscriptions” または “/rules” に対して行われます。

要求

次のように、Enumeration 要求を作成できます。

Method	要求 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します。

要求ヘッダー

必須要求ヘッダーと省略可能な要求ヘッダーを次の表に示します。

要求ヘッダー	説明
承認	"管理" 権限を持つ Shared Access Signature (SAS) トークンを指定します。詳細については、「 Shared Access Signature を使用した Service Bus 認証」を参照してください。

要求本文

なし。

[応答]

応答には、HTTP 状態コードおよび一連の応答ヘッダーが含まれています。

応答コード

コード	説明
200	OK です。
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} 要素の可能な内容については、「概要」を参照してください。

列挙

要求

クエリ パラメーターの$skipと$top