Web Pub Sub - Generate Client Token

Служба:

Azure Web PubSub Service

Версия API:

2024-01-01

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

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

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

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

Параметры 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.
clientType	query		WebPubSubClientType	Тип клиента. Без учета регистра. Если значение не задано, это значение default. Для web PubSub для Socket.IO поддерживается только значение по умолчанию. Для Web PubSub допустимые значения: Default и MQTT.
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=2024-01-01&clientType=MQTT

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

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

200

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

Определения

Имя	Описание
ClientTokenResponse	Объект ответа, содержащий маркер для клиента
ErrorDetail	Объект ошибки.
InnerError
WebPubSubClientType	Тип клиента. Без учета регистра. Если значение не задано, это значение default. Для web PubSub для Socket.IO поддерживается только значение по умолчанию. Для Web PubSub допустимые значения: Default и MQTT.

ClientTokenResponse

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

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

ErrorDetail

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

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

InnerError

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

WebPubSubClientType

Тип клиента. Без учета регистра. Если значение не задано, это значение default. Для web PubSub для Socket.IO поддерживается только значение по умолчанию. Для Web PubSub допустимые значения: Default и MQTT.

Имя	Тип	Описание
Default	string
MQTT	string