Web Pub Sub - Close All Connections

Služba:

Azure Web PubSub Service

Verze rozhraní API:

2024-01-01

Zavřete připojení v centru.

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

S volitelnými parametry:

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
endpoint	path	True	string url	Koncový bod HTTP nebo HTTPS pro instanci služby Web PubSub.
hub	path	True	string	Název cílového centra, který by měl začínat abecedním znakem a obsahovat pouze alfanumerické znaky nebo podtržítko. Vzor regulárního výrazu: ^[A-Za-z][A-Za-z0-9_`,.[\]]{0,127}$
api-version	query	True	string	Verze rozhraní REST API.
excluded	query		string[]	Při zavírání připojení v centru tyto ID připojení vyloučíte.
reason	query		string	Důvod zavření připojení klienta.

Odpovědi

Name	Typ	Description
204 No Content		Žádný obsah
Other Status Codes	ErrorDetail	Chybová odpověď Hlavičky x-ms-error-code: string

Příklady

WebPubSub_CloseAllConnections

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:

204

Definice

Name	Description
ErrorDetail	Objekt chyby.
InnerError

ErrorDetail

Objekt chyby.

Name	Typ	Description
code	string	Jedna ze serverově definovaných kódů chyb.
details	ErrorDetail[]	Pole podrobností o konkrétních chybách, které vedly k této nahlášené chybě.
inner	InnerError
message	string	Čitelné znázornění chyby člověkem.
target	string	Cíl chyby.

InnerError

Name	Typ	Description
code	string	Konkrétnější kód chyby, než poskytla chyba obsahující chybu.
inner	InnerError