Web Pub Sub - Close All Connections

ハブ内の接続を閉じます。

POST {endpoint}/api/hubs/{hub}/:closeConnections?api-version=2024-01-01

省略可能なパラメーターを含む:

POST {endpoint}/api/hubs/{hub}/:closeConnections?excluded={excluded}&reason={reason}&api-version=2024-01-01

URI パラメーター

名前	/	必須	型	説明
endpoint	path	True	string url	Web PubSub サービスインスタンスの HTTP または HTTPS エンドポイント。
hub	path	True	string	ターゲットハブ名。アルファベット文字で始まり、英数字またはアンダースコアのみを含む必要があります。正規表現パターン: ^[A-Za-z][A-Za-z0-9_`,.[\]]{0,127}$
api-version	query	True	string	REST API のバージョン。
excluded	query		string[]	ハブで接続を閉じるときに、これらの connectionId を除外します。
reason	query		string	クライアント接続を閉じる理由。

名前	型	説明
204 No Content		コンテンツなし
Other Status Codes	ErrorDetail	エラー応答ヘッダー x-ms-error-code: string

名前

型

説明

204 No Content

コンテンツなし

Other Status Codes

エラー応答

ヘッダー

x-ms-error-code: string

POST {endpoint}/api/hubs/hub1/:closeConnections?reason=Close reason&api-version=2024-01-01

名前	説明
ErrorDetail	エラーオブジェクト。
InnerError

エラーオブジェクト。

名前	型	説明
code	string	サーバー定義の一連のエラーコードの 1 つ。
details	ErrorDetail[]	この報告されたエラーの原因となった特定のエラーに関する詳細の配列。
inner	InnerError
message	string	エラーの人間が判読できる表現。
target	string	エラーのターゲット。

名前	型	説明
code	string	含まれているエラーによって提供されたよりも具体的なエラーコード。
inner	InnerError