你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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 参数

名称	在	必需	类型	说明
endpoint	path	True	string url	Web PubSub 服务实例的 HTTP 或 HTTPS 终结点。
hub	path	True	string	目标中心名称，该名称应以字母字符开头，并且仅包含字母数字字符或下划线。 正则表达式模式: ^[A-Za-z][A-Za-z0-9_`,.[\]]{0,127}$
userId	path	True	string	用户 ID。
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_CloseUserConnections

示例请求

HTTP

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

示例响应

状态代码:

204

定义

名称	说明
ErrorDetail	错误对象。
InnerError

ErrorDetail

错误对象。

名称	类型	说明
code	string	服务器定义的错误代码集之一。
details	ErrorDetail[]	导致此报告错误的特定错误的详细信息数组。
inner	InnerError
message	string	错误的人工可读表示形式。
target	string	错误的目标。

InnerError

名称	类型	说明
code	string	比包含的错误提供的错误代码更具体。
inner	InnerError