Freigeben über

Web Pub Sub - Send To All

  • Referenz
Dienst:
Azure Web PubSub Service
API-Version:
2024-01-01

Übertragen von Inhalten innerhalb des Anforderungstexts an alle verbundenen Clientverbindungen.

POST {endpoint}/api/hubs/{hub}/:send?api-version=2024-01-01
Mit optionalen Parametern: 
POST {endpoint}/api/hubs/{hub}/:send?excluded={excluded}&api-version=2024-01-01&filter={filter}&messageTtlSeconds={messageTtlSeconds}

URI-Parameter

Name In Erforderlich Typ Beschreibung
endpoint
 path True

string

url

HTTP- oder HTTPS-Endpunkt für die Web PubSub-Dienstinstanz.
hub
 path True

string

Zielhubname, der mit alphabetischen Zeichen beginnen und nur alphanumerische Zeichen oder Unterstriche enthalten soll.

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

string

Die Version der REST-APIs.
excluded
 query

string[]

Ausgeschlossene Verbindungs-IDs.
filter
 query

string

Folgen sie der OData-Filtersyntax, um die Abonnenten herauszufiltern, die die Nachrichten erhalten.
messageTtlSeconds
 query

integer

int32

Der Zeit-zu-Live-Wert (TTL) in Sekunden für Nachrichten, die an den Dienst gesendet werden. 0 ist der Standardwert, was bedeutet, dass die Nachricht nie abläuft. 300 ist der Maximalwert. Wenn dieser Parameter ungleich Null ist, werden nachrichten, die nicht vom Client innerhalb der angegebenen TTL verwendet werden, vom Dienst gelöscht. Dieser Parameter kann hilfreich sein, wenn die Bandbreite des Clients begrenzt ist.

Anforderungstext

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

Name Typ Beschreibung
message

string

Der Nutzlasttext.

Antworten

Name Typ Beschreibung
202 Accepted

Die Nachricht wird akzeptiert. Der Dienst folgt dem Feuer-und-Vergessen-Muster beim Senden von Nachrichten.
Other Status Codes

ErrorDetail

Fehlerantwort

Header

x-ms-error-code: string

Beispiele

WebPubSub_SendToAll

Beispielanforderung

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

"Message to send"

Beispiel für eine Antwort

Statuscode:
202

Definitionen

Name Beschreibung
ErrorDetail

Das Fehlerobjekt.
InnerError

ErrorDetail

Das Fehlerobjekt.

Name Typ Beschreibung
code

string

Eine serverdefinierte Gruppe von Fehlercodes.
details

ErrorDetail[]

Ein Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.
inner

InnerError

message

string

Eine lesbare Darstellung des Fehlers.
target

string

Das Ziel des Fehlers.

InnerError

Name Typ Beschreibung
code

string

Ein spezifischerer Fehlercode als vom enthaltenden Fehler bereitgestellt wurde.
inner

InnerError