Web Pub Sub - Remove Connections From Groups

Usługa:

Azure Web PubSub Service

Wersja interfejsu API:

2024-01-01

Usuń odfiltrowane połączenia z wielu grup.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
endpoint	path	True	string (url)	Punkt końcowy HTTP lub HTTPS dla wystąpienia usługi Web PubSub.
hub	path	True	string pattern: ^[A-Za-z][A-Za-z0-9_`,.[\]]{0,127}$	Nazwa centrum docelowego, która powinna zaczynać się od znaków alfabetycznych i zawierać tylko znaki alfanumeryczne lub podkreślenie.
api-version	query	True	string	Wersja interfejsów API REST.

Treść żądania

Nazwa	Typ	Opis
filter	string	Filtr OData, który spełnia wymagania połączeń docelowych
groups	string[]	Lista grup, z których zostaną usunięte połączenia docelowe

Odpowiedzi

Nazwa	Typ	Opis
200 OK		Sukces
Other Status Codes	ErrorDetail	Odpowiedź na błąd Nagłówki x-ms-error-code: string

Przykłady

WebPubSub_RemoveConnectionsFromGroups

Przykładowe żądanie

HTTP

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

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

Przykładowa odpowiedź

Kod stanu:

200

Definicje

Nazwa	Opis
ErrorDetail	Obiekt błędu.
InnerError
RemoveFromGroupsRequest	Obiekt żądania zawierający grupy obiektów docelowych i filtr połączenia

ErrorDetail

Objekt

Obiekt błędu.

Nazwa	Typ	Opis
code	string	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
details	ErrorDetail[]	Tablica szczegółów dotyczących określonych błędów, które doprowadziły do tego zgłoszonego błędu.
inner	InnerError
message	string	Czytelna dla człowieka reprezentacja błędu.
target	string	Element docelowy błędu.

InnerError

Objekt

Nazwa	Typ	Opis
code	string	Bardziej szczegółowy kod błędu niż został dostarczony przez błąd zawierający.
inner	InnerError

RemoveFromGroupsRequest

Objekt

Obiekt żądania zawierający grupy obiektów docelowych i filtr połączenia

Nazwa	Typ	Opis
filter	string	Filtr OData, który spełnia wymagania połączeń docelowych
groups	string[]	Lista grup, z których zostaną usunięte połączenia docelowe