Web Pub Sub - Generate Client Token

Servicio:

Azure Web PubSub Service

Versión de la API:

2024-01-01

Genere el token para que el cliente conecte el servicio Azure Web PubSub.

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

Con parámetros opcionales:

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
endpoint	path	True	string url	Punto de conexión HTTP o HTTPS para la instancia del servicio Web PubSub.
hub	path	True	string	Nombre del centro de destino, que debe comenzar con caracteres alfabéticos y solo contener caracteres alfanuméricos o caracteres de subrayado. Patrón de Regex: ^[A-Za-z][A-Za-z0-9_`,.[\]]{0,127}$
api-version	query	True	string	Versión de las API REST.
clientType	query		WebPubSubClientType	Tipo de cliente. No distingue mayúsculas de minúsculas. Si no se establece, es "Valor predeterminado". Para Web PubSub para Socket.IO, solo se admite el valor predeterminado. Para Web PubSub, los valores válidos son "Default" y "MQTT".
group	query		string[]	Grupos a los que se unirá la conexión cuando se conecte.
minutesToExpire	query		integer int32	Hora de expiración del token generado.
role	query		string[]	Roles que tendrá la conexión con el token generado.
userId	query		string	Id. de usuario.

Respuestas

Nombre	Tipo	Description
200 OK	ClientTokenResponse	Éxito Media Types: "text/plain", "application/json", "text/json"
Other Status Codes	ErrorDetail	Respuesta de error Media Types: "text/plain", "application/json", "text/json" Encabezados x-ms-error-code: string

Ejemplos

WebPubSub_GenerateClientToken

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

status code:

200

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

Definiciones

Nombre	Description
ClientTokenResponse	Objeto de respuesta que contiene el token para el cliente
ErrorDetail	Objeto de error.
InnerError
WebPubSubClientType	Tipo de cliente. No distingue mayúsculas de minúsculas. Si no se establece, es "Valor predeterminado". Para Web PubSub para Socket.IO, solo se admite el valor predeterminado. Para Web PubSub, los valores válidos son "Default" y "MQTT".

ClientTokenResponse

Objeto de respuesta que contiene el token para el cliente

Nombre	Tipo	Description
token	string	Valor de token del cliente de WebSocket para conectarse al servicio

ErrorDetail

Objeto de error.

Nombre	Tipo	Description
code	string	Uno de un conjunto definido por el servidor de códigos de error.
details	ErrorDetail[]	Matriz de detalles sobre errores específicos que llevaron a este error notificado.
inner	InnerError
message	string	Representación legible del error.
target	string	Destino del error.

InnerError

Nombre	Tipo	Description
code	string	Código de error más específico del proporcionado por el error contenedor.
inner	InnerError

WebPubSubClientType

Tipo de cliente. No distingue mayúsculas de minúsculas. Si no se establece, es "Valor predeterminado". Para Web PubSub para Socket.IO, solo se admite el valor predeterminado. Para Web PubSub, los valores válidos son "Default" y "MQTT".

Nombre	Tipo	Description
Default	string
MQTT	string