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	Конечная точка HTTP или HTTPS для экземпляра службы Web PubSub.
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[]	Исключите эти идентификаторы подключения при закрытии подключений в группе.
reason	query		string	Причина закрытия подключения клиента.

Ответы

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

Примеры

WebPubSub_CloseGroupConnections

Образец запроса

HTTP

POST {endpoint}/api/hubs/hub1/groups/group1/: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