Web Pub Sub - Close All Connections

Служба:

Azure Web PubSub Service

Версия API:

2023-07-01

Закройте подключения в концентраторе.

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

С использованием необязательных параметров:

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
endpoint	path	True	string url	Конечная точка HTTP или HTTPS для экземпляра службы Web PubSub.
hub	path	True	string	Имя целевого концентратора, которое должно начинаться с букв и содержать только буквенно-цифровые символы или символы подчеркивания. Шаблон регулярного выражения: ^[A-Za-z][A-Za-z0-9_`,.[\]]{0,127}$
api-version	query	True	string	Версия REST API.
excluded	query		string[]	Исключите эти идентификаторы подключения при закрытии подключений в концентраторе.
reason	query		string	Причина закрытия клиентского подключения.

Ответы

Имя	Тип	Описание
204 No Content		Нет содержимого
Other Status Codes	ErrorDetail	Сообщение об ошибке Заголовки x-ms-error-code: string

Примеры

WebPubSub_CloseAllConnections

Sample request

HTTP

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

Sample response

Status code:

204

Определения

Имя	Описание
ErrorDetail	Объект error.
InnerError

ErrorDetail

Объект error.

Имя	Тип	Описание
code	string	Один из определяемого сервером набора кодов ошибок.
details	ErrorDetail[]	Массив сведений о конкретных ошибках, которые привели к этой сообщаемой ошибке.
inner	InnerError
message	string	Удобочитаемое представление ошибки.
target	string	Цель ошибки.

InnerError

Имя	Тип	Описание
code	string	Более конкретный код ошибки, чем был предоставлен содержащей ошибкой.
inner	InnerError