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


Web Pub Sub - Add User To Group

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

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

userId
path True

string

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

api-version
query True

string

Версия REST API.

Ответы

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

Успех

Other Status Codes

ErrorDetail

Ответ на ошибку

Заголовки

x-ms-error-code: string

Примеры

WebPubSub_AddUserToGroup

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

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

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

Определения

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

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

InnerError

ErrorDetail

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

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

string

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

details

ErrorDetail[]

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

inner

InnerError

message

string

Читаемое пользователем представление ошибки.

target

string

Целевой объект ошибки.

InnerError

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

string

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

inner

InnerError