Send To Connection - Send To Connection

Usługa:

Azure Web PubSub Service

Wersja interfejsu API:

2024-12-01

Wyślij zawartość wewnątrz treści żądania do określonego połączenia.

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

Z parametrami opcjonalnymi:

POST {endpoint}/api/hubs/{hub}/connections/{connectionId}/:send?api-version=2024-12-01&messageTtlSeconds={messageTtlSeconds}

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
connectionId	path	True	string minLength: 1	Identyfikator połączenia.
endpoint	path	True	string (uri)	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 minLength: 1	Wersja interfejsu API do użycia dla tej operacji.
messageTtlSeconds	query		integer (int32) minimum: 0 maximum: 300	Wartość czasu wygaśnięcia (TTL) w sekundach dla wiadomości wysyłanych do usługi. 0 jest wartością domyślną, co oznacza, że wiadomość nigdy nie wygasa. 300 to wartość maksymalna. Jeśli ten parametr jest różny od zera, komunikaty, które nie są używane przez klienta w określonym czasie wygaśnięcia, zostaną porzucone przez usługę. Ten parametr może być pomocny, gdy przepustowość klienta jest ograniczona.

Treść żądania

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

Nazwa	Typ	Opis
message	string (byte)	Skrzynia ładunkowa.

Odpowiedzi

Nazwa	Typ	Opis
202 Accepted		Żądanie zostało zaakceptowane do przetwarzania, ale przetwarzanie nie zostało jeszcze ukończone.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Nieoczekiwana odpowiedź na błąd. Nagłówki x-ms-error-code: string

Zabezpieczenia

OAuth2Auth

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
https://webpubsub.azure.com/.default

Przykłady

SendToConnection

Przykładowe żądanie

HTTP

POST {endpoint}/api/hubs/hub1/connections/connection1/:send?api-version=2024-12-01&messageTtlSeconds=15

"TWVzc2FnZSB0byBzZW5k"

Przykładowa odpowiedź

Kod stanu:

202

Definicje

Nazwa	Opis
Azure.Core.Foundations.Error	Obiekt błędu.
Azure.Core.Foundations.ErrorResponse	Odpowiedź zawierająca szczegóły błędu.
Azure.Core.Foundations.InnerError	Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z Azure wytycznymi API REST - https://aka.ms/AzureRestApiGuidelines#handling-errors.

Azure.Core.Foundations.Error

Objekt

Obiekt błędu.

Nazwa	Typ	Opis
code	string	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
details	Azure.Core.Foundations.Error[]	Tablica szczegółów dotyczących określonych błędów, które doprowadziły do tego zgłoszonego błędu.
innererror	Azure.Core.Foundations.InnerError	Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.
message	string	Czytelna dla człowieka reprezentacja błędu.
target	string	Element docelowy błędu.

Azure.Core.Foundations.ErrorResponse

Objekt

Odpowiedź zawierająca szczegóły błędu.

Nazwa	Typ	Opis
error	Azure.Core.Foundations.Error	Obiekt błędu.

Azure.Core.Foundations.InnerError

Objekt

Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z Azure wytycznymi API REST - https://aka.ms/AzureRestApiGuidelines#handling-errors.

Nazwa	Typ	Opis
code	string	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
innererror	Azure.Core.Foundations.InnerError	Błąd wewnętrzny.