Web Pub Sub - Close User Connections

Dienst:

Azure Web PubSub Service

API-Version:

2024-01-01

Schließen Sie Verbindungen für den jeweiligen Benutzer.

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

Mit optionalen Parametern:

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

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	Zielhubname, der mit alphabetischen Zeichen beginnen und nur alphanumerische Zeichen oder Unterstriche enthalten soll. RegEx-Muster: ^[A-Za-z][A-Za-z0-9_`,.[\]]{0,127}$
userId	path	True	string	Die Benutzer-ID.
api-version	query	True	string	Die Version der REST-APIs.
excluded	query		string[]	Schließen Sie diese connectionIds aus, wenn Sie die Verbindungen für den Benutzer schließen.
reason	query		string	Der Grund zum Schließen der Clientverbindung.

Antworten

Name	Typ	Beschreibung
204 No Content		Kein Inhalt
Other Status Codes	ErrorDetail	Fehlerantwort Header x-ms-error-code: string

Beispiele

WebPubSub_CloseUserConnections

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:

204

Definitionen

Name	Beschreibung
ErrorDetail	Das Fehlerobjekt.
InnerError

ErrorDetail

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

Name	Typ	Beschreibung
code	string	Ein spezifischerer Fehlercode als vom enthaltenden Fehler bereitgestellt wurde.
inner	InnerError