Web Pub Sub - Remove Connections From Groups

Servizio:

Azure Web PubSub Service

Versione API:

2024-01-01

Rimuovere le connessioni filtrate da più gruppi.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
endpoint	path	True	string url	Endpoint HTTP o HTTPS per l'istanza del servizio Web PubSub.
hub	path	True	string	Nome dell'hub di destinazione, che deve iniziare con caratteri alfabetici e contenere solo caratteri alfanumerici o caratteri di sottolineatura. Criterio di espressione regolare: ^[A-Za-z][A-Za-z0-9_`,.[\]]{0,127}$
api-version	query	True	string	Versione delle API REST.

Corpo della richiesta

Nome	Tipo	Descrizione
filter	string	Filtro OData che soddisfa le connessioni di destinazione
groups	string[]	Elenco di gruppi da cui verranno rimosse le connessioni di destinazione

Risposte

Nome	Tipo	Descrizione
200 OK		Successo
Other Status Codes	ErrorDetail	Risposta di errore Intestazioni x-ms-error-code: string

Esempio

WebPubSub_RemoveConnectionsFromGroups

Esempio di richiesta

HTTP

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

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

Risposta di esempio

Codice di stato:

200

Definizioni

Nome	Descrizione
ErrorDetail	Oggetto error.
InnerError
RemoveFromGroupsRequest	Oggetto richiesta contenente i gruppi di destinazioni e un filtro di connessione

ErrorDetail

Oggetto error.

Nome	Tipo	Descrizione
code	string	Uno di un set definito dal server di codici di errore.
details	ErrorDetail[]	Matrice di dettagli sugli errori specifici che hanno causato l'errore segnalato.
inner	InnerError
message	string	Rappresentazione leggibile dell'errore.
target	string	Destinazione dell'errore.

InnerError

Nome	Tipo	Descrizione
code	string	Codice di errore più specifico di quello fornito dall'errore contenitore.
inner	InnerError

RemoveFromGroupsRequest

Oggetto richiesta contenente i gruppi di destinazioni e un filtro di connessione

Nome	Tipo	Descrizione
filter	string	Filtro OData che soddisfa le connessioni di destinazione
groups	string[]	Elenco di gruppi da cui verranno rimosse le connessioni di destinazione