Web Pub Sub - Close User Connections
Закройте подключения для конкретного пользователя.
POST {endpoint}/api/hubs/{hub}/users/{userId}/:closeConnections?api-version=2023-07-01
POST {endpoint}/api/hubs/{hub}/users/{userId}/:closeConnections?excluded={excluded}&reason={reason}&api-version=2023-07-01
Параметры URI
Имя | В | Обязательно | Тип | Описание |
---|---|---|---|---|
endpoint
|
path | True |
string url |
Конечная точка HTTP или HTTPS для экземпляра службы Web PubSub. |
hub
|
path | True |
string |
Имя целевого концентратора, которое должно начинаться с букв и содержать только буквенно-цифровые символы или символы подчеркивания. Шаблон регулярного выражения: |
user
|
path | True |
string |
Идентификатор пользователя. |
api-version
|
query | True |
string |
Версия REST API. |
excluded
|
query |
string[] |
Исключите эти идентификаторы подключения при закрытии подключений для пользователя. |
|
reason
|
query |
string |
Причина закрытия клиентского подключения. |
Ответы
Имя | Тип | Описание |
---|---|---|
204 No Content |
Нет содержимого |
|
Other Status Codes |
Сообщение об ошибке Заголовки x-ms-error-code: string |
Примеры
WebPubSub_CloseUserConnections
Sample request
POST {endpoint}/api/hubs/hub1/users/user1/:closeConnections?reason=Close reason&api-version=2023-07-01
Sample response
Определения
Имя | Описание |
---|---|
Error |
Объект error. |
Inner |
ErrorDetail
Объект error.
Имя | Тип | Описание |
---|---|---|
code |
string |
Один из определяемого сервером набора кодов ошибок. |
details |
Массив сведений о конкретных ошибках, которые привели к этой сообщаемой ошибке. |
|
inner | ||
message |
string |
Удобочитаемое представление ошибки. |
target |
string |
Цель ошибки. |
InnerError
Имя | Тип | Описание |
---|---|---|
code |
string |
Более конкретный код ошибки, чем был предоставлен содержащей ошибкой. |
inner |