リレーを取得する

  • [アーティクル]

重要

この API は廃止され、2021 年 11 月 1 日に廃止され、使用されなくなりました。

この操作は、サービス名前空間内のパブリックに利用可能なリレー エンドポイントを列挙します。

Request

Method 要求 URI HTTP バージョン
GET https://management.core.windows.net/{subscription ID}/services/ServiceBus/ Namespaces/{Namespace}/Relays/$skip={skip}&$top={top}

{skip} はスキップするエントリの数で、{top} は取得するエントリの数です。		 HTTP/1.1

要求ヘッダー

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

要求ヘッダー 説明
名前空間 管理エンドポイントの URL
x-ms-version 2012-03-01

この要求ではクライアント証明書も必要です。 この証明書は、特定のサブスクリプション用にアップロードした証明書に一致する必要があります。

要求本文

なし。

[応答]

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

応答コード

コード 説明
200 リレー エンドポイント ポリシーが正常に取得されました。
401 認証エラー。 ユーザーが名前空間リレー エンドポイント ポリシーを取得するための資格情報を持っていない場合に返されます。 サブスクリプションの中断が原因である可能性があります。
404 この名前空間にエンティティが存在しません。
500 内部/未処理の例外。

状態コードの詳細については、「 状態コードとエラー コード」を参照してください。

レスポンス ヘッダー

この操作の応答には、次のヘッダーが含まれています。 応答に追加の標準 HTTP ヘッダーが含まれる場合もあります。 すべての標準ヘッダーは 、HTTP/1.1 プロトコル仕様に準拠しています。

応答ヘッダー 説明
Content-Type application/xml;type=collection;charset=utf-8

応答本文

API は、各リレー エンドポイント ポリシーを表す XML AtomPub ドキュメントを返します。次の要素があります。

プロパティ名 Type 説明
名前 String エンドポイント名
リスナーの種類 String リスナーの種類のグループ。 有効な値:

-ユニキャスト
-マルチキャスト
- DirectConnection
- HybridConnection
- RelayedConnection
- RelayedHttp
NumberOfListeners Integer 現在アクティブなリスナーの数