Web Pub Sub - Close User Connections

Servizio:

Azure Web PubSub Service

Versione API:

2024-01-01

Chiudere le connessioni per l'utente specifico.

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

Con parametri facoltativi:

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
endpoint	path	True	string url	Endpoint HTTP o HTTPS per l'istanza del servizio Web PubSub.
hub	path	True	string	Nome dell'hub di destinazione, che deve iniziare con caratteri alfabetici e contenere solo caratteri alfanumerici o caratteri di sottolineatura. Criterio di espressione regolare: ^[A-Za-z][A-Za-z0-9_`,.[\]]{0,127}$
userId	path	True	string	ID utente.
api-version	query	True	string	Versione delle API REST.
excluded	query		string[]	Escludere questi connectionId durante la chiusura delle connessioni per l'utente.
reason	query		string	Motivo della chiusura della connessione client.

Risposte

Nome	Tipo	Descrizione
204 No Content		Nessun contenuto
Other Status Codes	ErrorDetail	Risposta di errore Intestazioni x-ms-error-code: string

Esempio

WebPubSub_CloseUserConnections

Esempio di richiesta

HTTP

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

Risposta di esempio

Codice di stato:

204

Definizioni

Nome	Descrizione
ErrorDetail	Oggetto error.
InnerError

ErrorDetail

Oggetto error.

Nome	Tipo	Descrizione
code	string	Uno di un set definito dal server di codici di errore.
details	ErrorDetail[]	Matrice di dettagli sugli errori specifici che hanno causato l'errore segnalato.
inner	InnerError
message	string	Rappresentazione leggibile dell'errore.
target	string	Destinazione dell'errore.

InnerError

Nome	Tipo	Descrizione
code	string	Codice di errore più specifico di quello fornito dall'errore contenitore.
inner	InnerError