Web Pub Sub - Close Group Connections

Tjänst:

Azure Web PubSub Service

API-version:

2024-01-01

Stäng anslutningar i den specifika gruppen.

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

Med valfria parametrar:

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
endpoint	path	True	string url	HTTP- eller HTTPS-slutpunkt för web pubsub-tjänstinstansen.
group	path	True	string	Målgruppens namn, som ska vara större än 0 och mindre än 1025. Reguljärt uttrycksmönster: ^(?!\s+$).+$
hub	path	True	string	Målhubbens namn, som ska börja med alfabetiska tecken och endast innehålla alfanumeriska tecken eller understreck. Reguljärt uttrycksmönster: ^[A-Za-z][A-Za-z0-9_`,.[\]]{0,127}$
api-version	query	True	string	Versionen av REST-API:erna.
excluded	query		string[]	Exkludera dessa connectionIds när du stänger anslutningarna i gruppen.
reason	query		string	Orsaken till att klientanslutningen stängdes.

Svar

Name	Typ	Description
204 No Content		Inget innehåll
Other Status Codes	ErrorDetail	Felsvar Sidhuvuden x-ms-error-code: string

Exempel

WebPubSub_CloseGroupConnections

Exempelbegäran

HTTP

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

Exempelsvar

Statuskod:

204

Definitioner

Name	Description
ErrorDetail	Felobjektet.
InnerError

ErrorDetail

Felobjektet.

Name	Typ	Description
code	string	En av en serverdefinierad uppsättning felkoder.
details	ErrorDetail[]	En matris med information om specifika fel som ledde till det rapporterade felet.
inner	InnerError
message	string	En mänsklig läsbar representation av felet.
target	string	Målet för felet.

InnerError

Name	Typ	Description
code	string	En mer specifik felkod än vad som angavs av det innehållande felet.
inner	InnerError