Web Pub Sub - Generate Client Token

Служба:

Azure Web PubSub Service

Версия API:

2023-07-01

Создайте маркер, чтобы клиент подключил службу Azure Web PubSub.

POST {endpoint}/api/hubs/{hub}/:generateToken?api-version=2023-07-01

С использованием необязательных параметров:

POST {endpoint}/api/hubs/{hub}/:generateToken?userId={userId}&role={role}&minutesToExpire={minutesToExpire}&api-version=2023-07-01&group={group}

Параметры 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.
group	query		string[]	Группы, к которым подключение будет присоединяться при подключении.
minutesToExpire	query		integer int32	Время истечения срока действия созданного маркера.
role	query		string[]	Роли, которые будут иметь соединение с созданным маркером.
userId	query		string	Идентификатор пользователя.

Ответы

Имя	Тип	Описание
200 OK	ClientTokenResponse	Успешное завершение Media Types: "text/plain", "application/json", "text/json"
Other Status Codes	ErrorDetail	Сообщение об ошибке Media Types: "text/plain", "application/json", "text/json" Заголовки x-ms-error-code: string

Примеры

WebPubSub_GenerateClientToken

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

HTTP

POST {endpoint}/api/hubs/hub1/:generateToken?userId=user1&minutesToExpire=5&api-version=2023-07-01

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

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

200

{
  "token": "ABCDEFG.ABC.ABC"
}

Определения

Имя	Описание
ClientTokenResponse	Объект ответа, содержащий маркер для клиента.
ErrorDetail	Объект ошибки.
InnerError

ClientTokenResponse

Объект ответа, содержащий маркер для клиента.

Имя	Тип	Описание
token	string	Значение маркера для подключения клиента WebSocket к службе

ErrorDetail

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

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

InnerError

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