Delen via

Web Pub Sub - Send To Group

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

Inhoud binnen de aanvraagtekst verzenden naar een groep verbindingen.

POST {endpoint}/api/hubs/{hub}/groups/{group}/:send?api-version=2024-12-01
Met optionele parameters: 
POST {endpoint}/api/hubs/{hub}/groups/{group}/:send?excluded={excluded}&api-version=2024-12-01&filter={filter}&messageTtlSeconds={messageTtlSeconds}

URI-parameters

Name In Vereist Type Description
endpoint
 path True

string

url

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

string

Naam van de doelgroep, welke lengte groter moet zijn dan 0 en kleiner dan 1025.

Regex-patroon: ^(?!\s+$).+$
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.
excluded
 query

string[]

Uitgesloten verbindings-id's
filter
 query

string

Volg de syntaxis van het OData-filter om de abonnees te filteren die de berichten ontvangen.
messageTtlSeconds
 query

integer

int32

De TTL-waarde (Time-to-Live) in seconden voor berichten die naar de service worden verzonden. 0 is de standaardwaarde, wat betekent dat het bericht nooit verloopt. 300 is de maximumwaarde. Als deze parameter niet nul is, worden berichten die niet door de client binnen de opgegeven TTL worden verbruikt, verwijderd door de service. Deze parameter kan helpen wanneer de bandbreedte van de client beperkt is.

Aanvraagbody

Media Types: "application/octet-stream", "text/plain", "application/json"

Name Type Description
message

string

De hoofdtekst van de nettolading.

Antwoorden

Name Type Description
202 Accepted

Geaccepteerd
Other Status Codes

ErrorDetail

Foutreactie

Kopteksten

x-ms-error-code: string

Voorbeelden

WebPubSub_SendToGroup

Voorbeeldaanvraag

POST {endpoint}/api/hubs/hub1/groups/group1/:send?api-version=2024-12-01&filter=startswith(userId, 'listener-')&messageTtlSeconds=15

"Message to send"

Voorbeeldrespons

Statuscode:
202

Definities

Name Description
ErrorDetail

Het foutobject.
InnerError

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