Web Pub Sub - Close User Connections

服務:

Azure Web PubSub Service

API 版本:

2024-01-01

關閉特定用戶的連線。

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

含選擇性參數:

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

URI 參數

名稱	位於	必要	類型	Description
endpoint	path	True	string url	Web PubSub 服務實例的 HTTP 或 HTTPS 端點。
hub	path	True	string	目標中樞名稱，其開頭應為字母字元，且只包含英數位元或底線。 Regex 模式: ^[A-Za-z][A-Za-z0-9_`,.[\]]{0,127}$
userId	path	True	string	用戶標識碼。
api-version	query	True	string	REST API 的版本。
excluded	query		string[]	關閉使用者的連線時，請排除這些 connectionId。
reason	query		string	關閉客戶端連線的原因。

回應

名稱	類型	Description
204 No Content		無內容
Other Status Codes	ErrorDetail	錯誤回應 標題 x-ms-error-code: string

範例

WebPubSub_CloseUserConnections

範例要求

HTTP

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

範例回覆

狀態碼:

204

定義

名稱	Description
ErrorDetail	error 物件。
InnerError

ErrorDetail

error 物件。

名稱	類型	Description
code	string	其中一組伺服器定義的錯誤碼。
details	ErrorDetail[]	導致此錯誤之特定錯誤的詳細數據陣列。
inner	InnerError
message	string	錯誤的人類可讀取表示法。
target	string	錯誤的目標。

InnerError

名稱	類型	Description
code	string	比包含的錯誤所提供更明確的錯誤碼。
inner	InnerError