Freigeben über

Web Pub Sub - Generate Client Token

Dienst:
Azure Web PubSub Service
API-Version:
2024-01-01

Generieren Sie ein Token für den Client, um den Azure Web PubSub-Dienst zu verbinden.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
endpoint
 path True

string (url)

HTTP- oder HTTPS-Endpunkt für die Web PubSub-Dienstinstanz.
hub
 path True

string

pattern: ^[A-Za-z][A-Za-z0-9_`,.[\]]{0,127}$

Zielhubname, der mit alphabetischen Zeichen beginnen und nur alphanumerische Zeichen oder Unterstriche enthalten soll.
api-version
 query True

string

Die Version der REST-APIs.
clientType
 query

WebPubSubClientType

Der Clienttyp. Groß-/Kleinschreibung wird nicht beachtet. Wenn sie nicht festgelegt ist, ist sie "Standard". Für Web PubSub für Socket.IO wird nur der Standardwert unterstützt. Für Web PubSub sind die gültigen Werte "Default" und "MQTT".
group
 query

string[]

Gruppen, denen die Verbindung bei der Verbindung beitritt.
minutesToExpire
 query

integer (int32)

minimum: 1

Die Ablaufzeit des generierten Tokens.
role
 query

string[]

Rollen, über die die Verbindung mit dem generierten Token verfügt.
userId
 query

string

Benutzer-ID.

Antworten

Name Typ Beschreibung
200 OK

ClientTokenResponse

Erfolg

Media Types: "text/plain", "application/json", "text/json"
Other Status Codes

ErrorDetail

Fehlerantwort

Media Types: "text/plain", "application/json", "text/json"

Header

x-ms-error-code: string

Beispiele

WebPubSub_GenerateClientToken

Beispielanforderung

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

Beispiel für eine Antwort

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

Definitionen

Name Beschreibung
ClientTokenResponse

Das Antwortobjekt, das das Token für den Client enthält
ErrorDetail

Das Fehlerobjekt.
InnerError
WebPubSubClientType

Der Clienttyp. Groß-/Kleinschreibung wird nicht beachtet. Wenn sie nicht festgelegt ist, ist sie "Standard". Für Web PubSub für Socket.IO wird nur der Standardwert unterstützt. Für Web PubSub sind die gültigen Werte "Default" und "MQTT".

ClientTokenResponse

Objekt

Das Antwortobjekt, das das Token für den Client enthält

Name Typ Beschreibung
token

string

Der Tokenwert für den WebSocket-Client zum Herstellen einer Verbindung mit dem Dienst

ErrorDetail

Objekt

Das Fehlerobjekt.

Name Typ Beschreibung
code

string

Eine serverdefinierte Gruppe von Fehlercodes.
details

ErrorDetail[]

Ein Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.
inner

InnerError

message

string

Eine lesbare Darstellung des Fehlers.
target

string

Das Ziel des Fehlers.

InnerError

Objekt
Name Typ Beschreibung
code

string

Ein spezifischerer Fehlercode als vom enthaltenden Fehler bereitgestellt wurde.
inner

InnerError

WebPubSubClientType

Enumeration

Der Clienttyp. Groß-/Kleinschreibung wird nicht beachtet. Wenn sie nicht festgelegt ist, ist sie "Standard". Für Web PubSub für Socket.IO wird nur der Standardwert unterstützt. Für Web PubSub sind die gültigen Werte "Default" und "MQTT".

Wert Beschreibung
Default
MQTT