Web Pub Sub - Add Connections To Groups

Tjänst:

Azure Web PubSub Service

API-version:

2024-01-01

Lägg till filtrerade anslutningar till flera grupper.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
endpoint	path	True	string (url)	HTTP- eller HTTPS-slutpunkt för web pubsub-tjänstinstansen.
hub	path	True	string pattern: ^[A-Za-z][A-Za-z0-9_`,.[\]]{0,127}$	Målhubbens namn, som ska börja med alfabetiska tecken och endast innehålla alfanumeriska tecken eller understreck.
api-version	query	True	string	Versionen av REST-API:erna.

Begärandetext

Name	Typ	Description
filter	string	Ett OData-filter som målanslutningar uppfyller
groups	string[]	En lista över grupper som målanslutningar läggs till i

Svar

Name	Typ	Description
200 OK		Framgång
Other Status Codes	ErrorDetail	Felsvar Sidhuvuden x-ms-error-code: string

Exempel

WebPubSub_AddConnectionsToGroups

Exempelbegäran

HTTP

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

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

Exempelsvar

Statuskod:

200

Definitioner

Name	Description
AddToGroupsRequest	Begärandeobjektet som innehåller målgrupper och ett anslutningsfilter
ErrorDetail	Felobjektet.
InnerError

AddToGroupsRequest

Objekt

Begärandeobjektet som innehåller målgrupper och ett anslutningsfilter

Name	Typ	Description
filter	string	Ett OData-filter som målanslutningar uppfyller
groups	string[]	En lista över grupper som målanslutningar läggs till i

ErrorDetail

Objekt

Felobjektet.

Name	Typ	Description
code	string	En av en serverdefinierad uppsättning felkoder.
details	ErrorDetail[]	En matris med information om specifika fel som ledde till det rapporterade felet.
inner	InnerError
message	string	En mänsklig läsbar representation av felet.
target	string	Målet för felet.

InnerError

Objekt

Name	Typ	Description
code	string	En mer specifik felkod än vad som angavs av det innehållande felet.
inner	InnerError