Web Pub Sub - Send To All

Usługa:

Azure Web PubSub Service

Wersja interfejsu API:

2024-01-01

Emisja zawartości wewnątrz treści żądania do wszystkich połączonych połączeń klienta.

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

Z parametrami opcjonalnymi:

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
endpoint	path	True	string (url)	Punkt końcowy HTTP lub HTTPS dla wystąpienia usługi Web PubSub.
hub	path	True	string pattern: ^[A-Za-z][A-Za-z0-9_`,.[\]]{0,127}$	Nazwa centrum docelowego, która powinna zaczynać się od znaków alfabetycznych i zawierać tylko znaki alfanumeryczne lub podkreślenie.
api-version	query	True	string	Wersja interfejsów API REST.
excluded	query		string[]	Wykluczone identyfikatory połączeń.
filter	query		string	Po składni filtru OData w celu odfiltrowania subskrybentów odbierających komunikaty.
messageTtlSeconds	query		integer (int32) minimum: 0 maximum: 300	Wartość czasu wygaśnięcia (TTL) w sekundach dla komunikatów wysyłanych do usługi. 0 jest wartością domyślną, co oznacza, że komunikat nigdy nie wygasa. Wartość maksymalna to 300. Jeśli ten parametr jest inny niż zero, komunikaty, które nie są używane przez klienta w ramach określonego czasu wygaśnięcia, zostaną porzucone przez usługę. Ten parametr może pomóc, gdy przepustowość klienta jest ograniczona.

Treść żądania

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

Nazwa	Typ	Opis
message	string (binary)	Treść ładunku.

Odpowiedzi

Nazwa	Typ	Opis
202 Accepted		Wiadomość jest akceptowana. Usługa jest zgodna ze wzorcem fire-and-forget podczas wysyłania komunikatów.
Other Status Codes	ErrorDetail	Odpowiedź na błąd Nagłówki x-ms-error-code: string

Przykłady

WebPubSub_SendToAll

Przykładowe żądanie

HTTP

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

"Message to send"

Przykładowa odpowiedź

Kod stanu:

202

Definicje

Nazwa	Opis
ErrorDetail	Obiekt błędu.
InnerError

ErrorDetail

Objekt

Obiekt błędu.

Nazwa	Typ	Opis
code	string	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
details	ErrorDetail[]	Tablica szczegółów dotyczących określonych błędów, które doprowadziły do tego zgłoszonego błędu.
inner	InnerError
message	string	Czytelna dla człowieka reprezentacja błędu.
target	string	Element docelowy błędu.

InnerError

Objekt

Nazwa	Typ	Opis
code	string	Bardziej szczegółowy kod błędu niż został dostarczony przez błąd zawierający.
inner	InnerError