Web Pub Sub - Close User Connections

Service:

Azure Web PubSub Service

Version d'API:

2024-01-01

Fermez les connexions pour l’utilisateur spécifique.

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

Avec des paramètres facultatifs:

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
endpoint	path	True	string url	Point de terminaison HTTP ou HTTPS pour l’instance de service Web PubSub.
hub	path	True	string	Nom du hub cible, qui doit commencer par des caractères alphabétiques et ne contient que des caractères alphanumériques ou un trait de soulignement. Modèle d’expression régulière: ^[A-Za-z][A-Za-z0-9_`,.[\]]{0,127}$
userId	path	True	string	ID d’utilisateur.
api-version	query	True	string	Version des API REST.
excluded	query		string[]	Excluez ces id de connexion lors de la fermeture des connexions pour l’utilisateur.
reason	query		string	Raison de la fermeture de la connexion cliente.

Réponses

Nom	Type	Description
204 No Content		Aucun contenu
Other Status Codes	ErrorDetail	Réponse d’erreur En-têtes x-ms-error-code: string

Exemples

WebPubSub_CloseUserConnections

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:

204

Définitions

Nom	Description
ErrorDetail	Objet d’erreur.
InnerError

ErrorDetail

Objet d’erreur.

Nom	Type	Description
code	string	Un ensemble de codes d’erreur définis par le serveur.
details	ErrorDetail[]	Tableau de détails sur des erreurs spécifiques qui ont conduit à cette erreur signalée.
inner	InnerError
message	string	Représentation lisible par l’homme de l’erreur.
target	string	Cible de l’erreur.

InnerError

Nom	Type	Description
code	string	Code d’erreur plus spécifique que fourni par l’erreur contenante.
inner	InnerError