Web Pub Sub - Add Connections To Groups

Служба:

Azure Web PubSub Service

Версия API:

2023-07-01

Добавьте отфильтрованные подключения к нескольким группам.

POST {endpoint}/api/hubs/{hub}/:addToGroups?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.

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

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

Ответы

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

Примеры

WebPubSub_AddConnectionsToGroups

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

HTTP

POST {endpoint}/api/hubs/hub1/:addToGroups?api-version=2023-07-01

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

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

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

200

Определения

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

AddToGroupsRequest

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

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

ErrorDetail

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

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

InnerError

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