Web Pub Sub - Close Group Connections

Service:

Azure Web PubSub Service

API-versie:

2024-12-01

Sluit verbindingen in de specifieke groep.

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

Met optionele parameters:

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

URI-parameters

Name	In	Vereist	Type	Description
endpoint	path	True	string url	HTTP- of HTTPS-eindpunt voor het Web PubSub-service-exemplaar.
group	path	True	string	Naam van de doelgroep, welke lengte groter moet zijn dan 0 en kleiner dan 1025. Regex-patroon: ^(?!\s+$).+$
hub	path	True	string	Doelhubnaam, die moet beginnen met alfabetische tekens en alleen alfanumerieke tekens of onderstrepingstekens bevatten. Regex-patroon: ^[A-Za-z][A-Za-z0-9_`,.[\]]{0,127}$
api-version	query	True	string	De versie van de REST API's.
excluded	query		string[]	Sluit deze connectionIds uit bij het sluiten van de verbindingen in de groep.
reason	query		string	De reden voor het sluiten van de clientverbinding.

Antwoorden

Name	Type	Description
204 No Content		Geen inhoud
Other Status Codes	ErrorDetail	Foutreactie Kopteksten x-ms-error-code: string

Voorbeelden

WebPubSub_CloseGroupConnections

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

Statuscode:

204

Definities

Name	Description
ErrorDetail	Het foutobject.
InnerError

ErrorDetail

Object

Het foutobject.

Name	Type	Description
code	string	Een van een door de server gedefinieerde set foutcodes.
details	ErrorDetail[]	Een matrix met details over specifieke fouten die hebben geleid tot deze gemelde fout.
inner	InnerError
message	string	Een leesbare weergave van de fout.
target	string	Het doel van de fout.

InnerError

Object

Name	Type	Description
code	string	Een specifiekere foutcode dan is opgegeven door de bijbehorende fout.
inner	InnerError