Web Pub Sub - Remove Connections From Groups

Служба:

Azure Web PubSub Service

Версия API:

2024-01-01

Удалите отфильтрованные подключения из нескольких групп.

POST {endpoint}/api/hubs/{hub}/:removeFromGroups?api-version=2024-01-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.

Текст запроса

Имя	Тип	Описание
filter	string	Фильтр OData, который удовлетворяет целевым подключениям
groups	string[]	Список групп, из которых будут удалены целевые подключения.

Ответы

Имя	Тип	Описание
200 OK		Успех
Other Status Codes	ErrorDetail	Ответ на ошибку Заголовки x-ms-error-code: string

Примеры

WebPubSub_RemoveConnectionsFromGroups

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

HTTP

POST {endpoint}/api/hubs/hub1/:removeFromGroups?api-version=2024-01-01

{
  "groups": [
    "group1",
    "group2"
  ],
  "filter": "startswith(userId, 'listener-')"
}

Пример ответа

Код состояния:

200

Определения

Имя	Описание
ErrorDetail	Объект ошибки.
InnerError
RemoveFromGroupsRequest	Объект запроса, содержащий группы целевых объектов и фильтр подключения

ErrorDetail

Объект ошибки.

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

InnerError

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

RemoveFromGroupsRequest

Объект запроса, содержащий группы целевых объектов и фильтр подключения

Имя	Тип	Описание
filter	string	Фильтр OData, который удовлетворяет целевым подключениям
groups	string[]	Список групп, из которых будут удалены целевые подключения.