Web Pub Sub - Remove Connections From Groups

Service:

Azure Web PubSub Service

API-versie:

2024-01-01

Gefilterde verbindingen uit meerdere groepen verwijderen.

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

URI-parameters

Name	In	Vereist	Type	Description
endpoint	path	True	string url	HTTP- of HTTPS-eindpunt voor het Web PubSub-service-exemplaar.
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.

Aanvraagbody

Name	Type	Description
filter	string	Een OData-filter waaraan doelverbindingen voldoen
groups	string[]	Een lijst met groepen waaruit doelverbindingen worden verwijderd

Antwoorden

Name	Type	Description
200 OK		Succes
Other Status Codes	ErrorDetail	Foutreactie Kopteksten x-ms-error-code: string

Voorbeelden

WebPubSub_RemoveConnectionsFromGroups

Voorbeeldaanvraag

HTTP

POST {endpoint}/api/hubs/hub1/:removeFromGroups?api-version=2024-01-01

{
  "groups": [
    "group1",
    "group2"
  ],
  "filter": "startswith(userId, 'listener-')"
}

Voorbeeldrespons

Statuscode:

200

Definities

Name	Description
ErrorDetail	Het foutobject.
InnerError
RemoveFromGroupsRequest	Het aanvraagobject met doelengroepen en een verbindingsfilter

ErrorDetail

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

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

RemoveFromGroupsRequest

Het aanvraagobject met doelengroepen en een verbindingsfilter

Name	Type	Description
filter	string	Een OData-filter waaraan doelverbindingen voldoen
groups	string[]	Een lijst met groepen waaruit doelverbindingen worden verwijderd