Web Pub Sub - Close User Connections

Usługa:

Azure Web PubSub Service

Wersja interfejsu API:

2024-01-01

Zamknij połączenia dla określonego użytkownika.

POST {endpoint}/api/hubs/{hub}/users/{userId}/:closeConnections?api-version=2024-01-01

Z parametrami opcjonalnymi:

POST {endpoint}/api/hubs/{hub}/users/{userId}/:closeConnections?excluded={excluded}&reason={reason}&api-version=2024-01-01

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}$
userId	path	True	string	Identyfikator użytkownika.
api-version	query	True	string	Wersja interfejsów API REST.
excluded	query		string[]	Wyklucz te identyfikatory connectionId podczas zamykania połączeń dla użytkownika.
reason	query		string	Przyczyna zamknięcia połączenia klienta.

Odpowiedzi

Nazwa	Typ	Opis
204 No Content		Brak zawartości
Other Status Codes	ErrorDetail	Odpowiedź na błąd Nagłówki x-ms-error-code: string

Przykłady

WebPubSub_CloseUserConnections

Przykładowe żądanie

HTTP

POST {endpoint}/api/hubs/hub1/users/user1/:closeConnections?reason=Close reason&api-version=2024-01-01

Przykładowa odpowiedź

Kod stanu:

204

Definicje

Nazwa	Opis
ErrorDetail	Obiekt błędu.
InnerError

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