Web Pub Sub - Close Group Connections

  • リファレンス
サービス:
Azure Web PubSub Service
API バージョン:
2024-01-01

特定のグループ内の接続を閉じます。

POST {endpoint}/api/hubs/{hub}/groups/{group}/:closeConnections?api-version=2024-01-01
省略可能なパラメーターを含む: 
POST {endpoint}/api/hubs/{hub}/groups/{group}/:closeConnections?excluded={excluded}&reason={reason}&api-version=2024-01-01

URI パラメーター

名前 / 必須 型 説明
endpoint
 path True

string

url

Web PubSub サービス インスタンスの HTTP または HTTPS エンドポイント。
group
 path True

string

ターゲット グループ名。長さは 0 より大きく、1025 未満にする必要があります。

正規表現パターン: ^(?!\s+$).+$
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

例

WebPubSub_CloseGroupConnections

要求のサンプル

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

応答のサンプル

状態コード:
204

定義

名前 説明
ErrorDetail

エラー オブジェクト。
InnerError

ErrorDetail

エラー オブジェクト。

名前 型 説明
code

string

サーバー定義の一連のエラー コードの 1 つ。
details

ErrorDetail[]

この報告されたエラーの原因となった特定のエラーに関する詳細の配列。
inner

InnerError

message

string

エラーの人間が判読できる表現。
target

string

エラーのターゲット。

InnerError

名前 型 説明
code

string

含まれているエラーによって提供されたよりも具体的なエラー コード。
inner

InnerError