Поделиться через


Web Pub Sub - Add User To Group

Добавьте пользователя в целевую группу.

PUT {endpoint}/api/hubs/{hub}/users/{userId}/groups/{group}?api-version=2023-07-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}$

userId
path True

string

Идентификатор целевого пользователя.

api-version
query True

string

Версия REST API.

Ответы

Имя Тип Описание
200 OK

Успешное завершение

Other Status Codes

ErrorDetail

Сообщение об ошибке

Заголовки

x-ms-error-code: string

Примеры

WebPubSub_AddUserToGroup

Sample request

PUT {endpoint}/api/hubs/hub1/users/user1/groups/group1?api-version=2023-07-01

Sample response

Определения

Имя Описание
ErrorDetail

Объект error.

InnerError

ErrorDetail

Объект error.

Имя Тип Описание
code

string

Один из определяемого сервером набора кодов ошибок.

details

ErrorDetail[]

Массив сведений о конкретных ошибках, которые привели к этой сообщаемой ошибке.

inner

InnerError

message

string

Удобочитаемое представление ошибки.

target

string

Цель ошибки.

InnerError

Имя Тип Описание
code

string

Более конкретный код ошибки, чем был предоставлен содержащей ошибкой.

inner

InnerError