Web Pub Sub - Remove Connections From Groups

Služba:

Azure Web PubSub Service

Verze rozhraní API:

2024-01-01

Odeberte filtrovaná připojení z více skupin.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
endpoint	path	True	string url	Koncový bod HTTP nebo HTTPS pro instanci služby Web PubSub.
hub	path	True	string	Název cílového centra, který by měl začínat abecedním znakem a obsahovat pouze alfanumerické znaky nebo podtržítko. Vzor regulárního výrazu: ^[A-Za-z][A-Za-z0-9_`,.[\]]{0,127}$
api-version	query	True	string	Verze rozhraní REST API.

Text požadavku

Name	Typ	Description
filter	string	Filtr OData, který cílová připojení vyhovují
groups	string[]	Seznam skupin, ze kterých se odeberou cílová připojení

Odpovědi

Name	Typ	Description
200 OK		Úspěch
Other Status Codes	ErrorDetail	Chybová odpověď Hlavičky x-ms-error-code: string

Příklady

WebPubSub_RemoveConnectionsFromGroups

Ukázkový požadavek

HTTP

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

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

Ukázková odpověď

Stavový kód:

200

Definice

Name	Description
ErrorDetail	Objekt chyby.
InnerError
RemoveFromGroupsRequest	Objekt požadavku obsahující skupiny cílů a filtr připojení

ErrorDetail

Objekt chyby.

Name	Typ	Description
code	string	Jedna ze serverově definovaných kódů chyb.
details	ErrorDetail[]	Pole podrobností o konkrétních chybách, které vedly k této nahlášené chybě.
inner	InnerError
message	string	Čitelné znázornění chyby člověkem.
target	string	Cíl chyby.

InnerError

Name	Typ	Description
code	string	Konkrétnější kód chyby, než poskytla chyba obsahující chybu.
inner	InnerError

RemoveFromGroupsRequest

Objekt požadavku obsahující skupiny cílů a filtr připojení

Name	Typ	Description
filter	string	Filtr OData, který cílová připojení vyhovují
groups	string[]	Seznam skupin, ze kterých se odeberou cílová připojení