Web Pub Sub - Remove Connections From Groups

Dienst:

Azure Web PubSub Service

API-Version:

2024-01-01

Entfernen Sie gefilterte Verbindungen aus mehreren Gruppen.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string url	HTTP- oder HTTPS-Endpunkt für die Web PubSub-Dienstinstanz.
hub	path	True	string	Zielhubname, der mit alphabetischen Zeichen beginnen und nur alphanumerische Zeichen oder Unterstriche enthalten soll. RegEx-Muster: ^[A-Za-z][A-Za-z0-9_`,.[\]]{0,127}$
api-version	query	True	string	Die Version der REST-APIs.

Anforderungstext

Name	Typ	Beschreibung
filter	string	Ein OData-Filter, der Zielverbindungen erfüllt
groups	string[]	Eine Liste der Gruppen, aus denen Zielverbindungen entfernt werden

Antworten

Name	Typ	Beschreibung
200 OK		Erfolg
Other Status Codes	ErrorDetail	Fehlerantwort Header x-ms-error-code: string

Beispiele

WebPubSub_RemoveConnectionsFromGroups

Beispielanforderung

HTTP

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

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

Beispiel für eine Antwort

Statuscode:

200

Definitionen

Name	Beschreibung
ErrorDetail	Das Fehlerobjekt.
InnerError
RemoveFromGroupsRequest	Das Anforderungsobjekt, das Zielgruppen und einen Verbindungsfilter enthält

ErrorDetail

Das Fehlerobjekt.

Name	Typ	Beschreibung
code	string	Eine serverdefinierte Gruppe von Fehlercodes.
details	ErrorDetail[]	Ein Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.
inner	InnerError
message	string	Eine lesbare Darstellung des Fehlers.
target	string	Das Ziel des Fehlers.

InnerError

Name	Typ	Beschreibung
code	string	Ein spezifischerer Fehlercode als vom enthaltenden Fehler bereitgestellt wurde.
inner	InnerError

RemoveFromGroupsRequest

Das Anforderungsobjekt, das Zielgruppen und einen Verbindungsfilter enthält

Name	Typ	Beschreibung
filter	string	Ein OData-Filter, der Zielverbindungen erfüllt
groups	string[]	Eine Liste der Gruppen, aus denen Zielverbindungen entfernt werden