Web Pub Sub - Generate Client Token

Usługa:

Azure Web PubSub Service

Wersja interfejsu API:

2024-01-01

Wygeneruj token dla klienta, aby połączyć usługę Azure Web PubSub.

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

Z parametrami opcjonalnymi:

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
endpoint	path	True	string url	Punkt końcowy HTTP lub HTTPS dla wystąpienia usługi Web PubSub.
hub	path	True	string	Nazwa centrum docelowego, która powinna zaczynać się od znaków alfabetycznych i zawierać tylko znaki alfanumeryczne lub podkreślenie. Wzorzec wyrażenia regularnego: ^[A-Za-z][A-Za-z0-9_`,.[\]]{0,127}$
api-version	query	True	string	Wersja interfejsów API REST.
clientType	query		WebPubSubClientType	Typ klienta. Bez uwzględniania wielkości liter. Jeśli nie jest ustawiona, jest to "Wartość domyślna". W przypadku usługi Web PubSub dla Socket.IO obsługiwana jest tylko wartość domyślna. W przypadku usługi Web PubSub prawidłowe wartości to "Default" i "MQTT".
group	query		string[]	Grupy, które połączenie zostanie przyłączone podczas nawiązywania połączenia.
minutesToExpire	query		integer int32	Czas wygaśnięcia wygenerowanego tokenu.
role	query		string[]	Role, które będą miały połączenie z wygenerowany token.
userId	query		string	Identyfikator użytkownika.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	ClientTokenResponse	Sukces Media Types: "text/plain", "application/json", "text/json"
Other Status Codes	ErrorDetail	Odpowiedź na błąd Media Types: "text/plain", "application/json", "text/json" Nagłówki x-ms-error-code: string

Przykłady

WebPubSub_GenerateClientToken

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:

200

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

Definicje

Nazwa	Opis
ClientTokenResponse	Obiekt odpowiedzi zawierający token dla klienta
ErrorDetail	Obiekt błędu.
InnerError
WebPubSubClientType	Typ klienta. Bez uwzględniania wielkości liter. Jeśli nie jest ustawiona, jest to "Wartość domyślna". W przypadku usługi Web PubSub dla Socket.IO obsługiwana jest tylko wartość domyślna. W przypadku usługi Web PubSub prawidłowe wartości to "Default" i "MQTT".

ClientTokenResponse

Obiekt odpowiedzi zawierający token dla klienta

Nazwa	Typ	Opis
token	string	Wartość tokenu dla klienta protokołu WebSocket w celu nawiązania połączenia z usługą

ErrorDetail

Obiekt błędu.

Nazwa	Typ	Opis
code	string	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
details	ErrorDetail[]	Tablica szczegółów dotyczących określonych błędów, które doprowadziły do tego zgłoszonego błędu.
inner	InnerError
message	string	Czytelna dla człowieka reprezentacja błędu.
target	string	Element docelowy błędu.

InnerError

Nazwa	Typ	Opis
code	string	Bardziej szczegółowy kod błędu niż został dostarczony przez błąd zawierający.
inner	InnerError

WebPubSubClientType

Typ klienta. Bez uwzględniania wielkości liter. Jeśli nie jest ustawiona, jest to "Wartość domyślna". W przypadku usługi Web PubSub dla Socket.IO obsługiwana jest tylko wartość domyślna. W przypadku usługi Web PubSub prawidłowe wartości to "Default" i "MQTT".

Nazwa	Typ	Opis
Default	string
MQTT	string