Web Pub Sub - Remove Connections From Groups

Service:

Azure Web PubSub Service

Version d'API:

2024-01-01

Supprimez les connexions filtrées de plusieurs groupes.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
endpoint	path	True	string url	Point de terminaison HTTP ou HTTPS pour l’instance de service Web PubSub.
hub	path	True	string	Nom du hub cible, qui doit commencer par des caractères alphabétiques et ne contient que des caractères alphanumériques ou un trait de soulignement. Modèle d’expression régulière: ^[A-Za-z][A-Za-z0-9_`,.[\]]{0,127}$
api-version	query	True	string	Version des API REST.

Corps de la demande

Nom	Type	Description
filter	string	Filtre OData qui cible les connexions répondent
groups	string[]	Liste des groupes dont les connexions cibles seront supprimées

Réponses

Nom	Type	Description
200 OK		Succès
Other Status Codes	ErrorDetail	Réponse d’erreur En-têtes x-ms-error-code: string

Exemples

WebPubSub_RemoveConnectionsFromGroups

Exemple de requête

HTTP

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

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

Exemple de réponse

Code d’état:

200

Définitions

Nom	Description
ErrorDetail	Objet d’erreur.
InnerError
RemoveFromGroupsRequest	Objet de requête contenant des groupes cibles et un filtre de connexion

ErrorDetail

Objet d’erreur.

Nom	Type	Description
code	string	Un ensemble de codes d’erreur définis par le serveur.
details	ErrorDetail[]	Tableau de détails sur des erreurs spécifiques qui ont conduit à cette erreur signalée.
inner	InnerError
message	string	Représentation lisible par l’homme de l’erreur.
target	string	Cible de l’erreur.

InnerError

Nom	Type	Description
code	string	Code d’erreur plus spécifique que fourni par l’erreur contenante.
inner	InnerError

RemoveFromGroupsRequest

Objet de requête contenant des groupes cibles et un filtre de connexion

Nom	Type	Description
filter	string	Filtre OData qui cible les connexions répondent
groups	string[]	Liste des groupes dont les connexions cibles seront supprimées