Delen via

Web Pub Sub - Add Connections To Groups

  • Referentie
Service:
Azure Web PubSub Service
API-versie:
2024-12-01

Gefilterde verbindingen toevoegen aan meerdere groepen.

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

URI-parameters

Name In Vereist Type Description
endpoint
 path True

string

url

HTTP- of HTTPS-eindpunt voor het Web PubSub-service-exemplaar.
hub
 path True

string

Doelhubnaam, die moet beginnen met alfabetische tekens en alleen alfanumerieke tekens of onderstrepingstekens bevatten.

Regex-patroon: ^[A-Za-z][A-Za-z0-9_`,.[\]]{0,127}$
api-version
 query True

string

De versie van de REST API's.

Aanvraagbody

Name Type Description
filter

string

Een OData-filter waaraan doelverbindingen voldoen
groups

string[]

Een lijst met groepen waaraan doelverbindingen worden toegevoegd

Antwoorden

Name Type Description
200 OK

OK
Other Status Codes

ErrorDetail

Foutreactie

Kopteksten

x-ms-error-code: string

Voorbeelden

WebPubSub_AddConnectionsToGroups

Voorbeeldaanvraag

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

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

Voorbeeldrespons

Statuscode:
200

Definities

Name Description
AddToGroupsRequest

Het aanvraagobject met doelengroepen en een verbindingsfilter
ErrorDetail

Het foutobject.
InnerError

AddToGroupsRequest

Object

Het aanvraagobject met doelengroepen en een verbindingsfilter

Name Type Description
filter

string

Een OData-filter waaraan doelverbindingen voldoen
groups

string[]

Een lijst met groepen waaraan doelverbindingen worden toegevoegd

ErrorDetail

Object

Het foutobject.

Name Type Description
code

string

Een van een door de server gedefinieerde set foutcodes.
details

ErrorDetail[]

Een matrix met details over specifieke fouten die hebben geleid tot deze gemelde fout.
inner

InnerError

message

string

Een leesbare weergave van de fout.
target

string

Het doel van de fout.

InnerError

Object
Name Type Description
code

string

Een specifiekere foutcode dan is opgegeven door de bijbehorende fout.
inner

InnerError