Web Pub Sub - Generate Client Token

Servizio:

Azure Web PubSub Service

Versione API:

2024-01-01

Generare un token per il client per connettere il servizio PubSub Web di Azure.

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

Con parametri facoltativi:

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
endpoint	path	True	string url	Endpoint HTTP o HTTPS per l'istanza del servizio Web PubSub.
hub	path	True	string	Nome dell'hub di destinazione, che deve iniziare con caratteri alfabetici e contenere solo caratteri alfanumerici o caratteri di sottolineatura. Criterio di espressione regolare: ^[A-Za-z][A-Za-z0-9_`,.[\]]{0,127}$
api-version	query	True	string	Versione delle API REST.
clientType	query		WebPubSubClientType	Tipo di client. Senza distinzione tra maiuscole e minuscole. Se non è impostato, è "Default". Per Web PubSub per Socket.IO, è supportato solo il valore predefinito. Per Web PubSub, i valori validi sono 'Default' e 'MQTT'.
group	query		string[]	Gruppi a cui verrà aggiunta la connessione quando si connette.
minutesToExpire	query		integer int32	Ora di scadenza del token generato.
role	query		string[]	Ruoli che la connessione con il token generato avrà.
userId	query		string	ID utente.

Risposte

Nome	Tipo	Descrizione
200 OK	ClientTokenResponse	Successo Media Types: "text/plain", "application/json", "text/json"
Other Status Codes	ErrorDetail	Risposta di errore Media Types: "text/plain", "application/json", "text/json" Intestazioni x-ms-error-code: string

Esempio

WebPubSub_GenerateClientToken

Esempio di richiesta

HTTP

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

Risposta di esempio

Codice di stato:

200

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

Definizioni

Nome	Descrizione
ClientTokenResponse	Oggetto risposta contenente il token per il client
ErrorDetail	Oggetto error.
InnerError
WebPubSubClientType	Tipo di client. Senza distinzione tra maiuscole e minuscole. Se non è impostato, è "Default". Per Web PubSub per Socket.IO, è supportato solo il valore predefinito. Per Web PubSub, i valori validi sono 'Default' e 'MQTT'.

ClientTokenResponse

Oggetto risposta contenente il token per il client

Nome	Tipo	Descrizione
token	string	Valore del token per il client WebSocket per la connessione al servizio

ErrorDetail

Oggetto error.

Nome	Tipo	Descrizione
code	string	Uno di un set definito dal server di codici di errore.
details	ErrorDetail[]	Matrice di dettagli sugli errori specifici che hanno causato l'errore segnalato.
inner	InnerError
message	string	Rappresentazione leggibile dell'errore.
target	string	Destinazione dell'errore.

InnerError

Nome	Tipo	Descrizione
code	string	Codice di errore più specifico di quello fornito dall'errore contenitore.
inner	InnerError

WebPubSubClientType

Tipo di client. Senza distinzione tra maiuscole e minuscole. Se non è impostato, è "Default". Per Web PubSub per Socket.IO, è supportato solo il valore predefinito. Per Web PubSub, i valori validi sono 'Default' e 'MQTT'.

Nome	Tipo	Descrizione
Default	string
MQTT	string