Web Pub Sub - Generate Client Token

Service:

Azure Web PubSub Service

API-versie:

2024-01-01

Genereer token voor de client om verbinding te maken met de Azure Web PubSub-service.

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

Met optionele parameters:

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

URI-parameters

Name	In	Vereist	Type	Description
endpoint	path	True	string url	HTTP- of HTTPS-eindpunt voor het Web PubSub-service-exemplaar.
hub	path	True	string	Doelhubnaam, die moet beginnen met alfabetische tekens en alleen alfanumerieke tekens of onderstrepingstekens bevatten. Regex-patroon: ^[A-Za-z][A-Za-z0-9_`,.[\]]{0,127}$
api-version	query	True	string	De versie van de REST API's.
clientType	query		WebPubSubClientType	Het type client. Hoofdlettergevoelig. Als dit niet is ingesteld, is dit 'Standaard'. Voor Web PubSub voor Socket.IO wordt alleen de standaardwaarde ondersteund. Voor Web PubSub zijn de geldige waarden 'Standaard' en 'MQTT'.
group	query		string[]	Groepen waaraan de verbinding wordt gekoppeld wanneer deze verbinding maakt.
minutesToExpire	query		integer int32	De verlooptijd van het gegenereerde token.
role	query		string[]	Rollen die de verbinding met het gegenereerde token hebben.
userId	query		string	Gebruikersnaam.

Antwoorden

Name	Type	Description
200 OK	ClientTokenResponse	Succes Media Types: "text/plain", "application/json", "text/json"
Other Status Codes	ErrorDetail	Foutreactie Media Types: "text/plain", "application/json", "text/json" Kopteksten x-ms-error-code: string

Voorbeelden

WebPubSub_GenerateClientToken

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

Statuscode:

200

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

Definities

Name	Description
ClientTokenResponse	Het antwoordobject met het token voor de client
ErrorDetail	Het foutobject.
InnerError
WebPubSubClientType	Het type client. Hoofdlettergevoelig. Als dit niet is ingesteld, is dit 'Standaard'. Voor Web PubSub voor Socket.IO wordt alleen de standaardwaarde ondersteund. Voor Web PubSub zijn de geldige waarden 'Standaard' en 'MQTT'.

ClientTokenResponse

Het antwoordobject met het token voor de client

Name	Type	Description
token	string	De tokenwaarde voor de WebSocket-client om verbinding te maken met de service

ErrorDetail

Het foutobject.

Name	Type	Description
code	string	Een van een door de server gedefinieerde set foutcodes.
details	ErrorDetail[]	Een matrix met details over specifieke fouten die hebben geleid tot deze gemelde fout.
inner	InnerError
message	string	Een leesbare weergave van de fout.
target	string	Het doel van de fout.

InnerError

Name	Type	Description
code	string	Een specifiekere foutcode dan is opgegeven door de bijbehorende fout.
inner	InnerError

WebPubSubClientType

Het type client. Hoofdlettergevoelig. Als dit niet is ingesteld, is dit 'Standaard'. Voor Web PubSub voor Socket.IO wordt alleen de standaardwaarde ondersteund. Voor Web PubSub zijn de geldige waarden 'Standaard' en 'MQTT'.

Name	Type	Description
Default	string
MQTT	string