Send To Connection - Send To Connection

Služba:

Azure Web PubSub Service

Verze rozhraní API:

2024-12-01

Odešlete obsah uvnitř těla požadavku na konkrétní připojení.

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

S volitelnými parametry:

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
connectionId	path	True	string minLength: 1	ID připojení.
endpoint	path	True	string (uri)	Koncový bod HTTP nebo HTTPS pro instanci služby Web PubSub
hub	path	True	string pattern: ^[A-Za-z][A-Za-z0-9_`,.[\]]{0,127}$	Název cílového centra, který by měl začínat abecedními znaky a obsahovat pouze alfanumerické znaky nebo podtržítko.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.
messageTtlSeconds	query		integer (int32) minimum: 0 maximum: 300	Hodnota TTL (Time-to-Live) v sekundách pro zprávy odeslané do služby. 0 je výchozí hodnota, což znamená, že platnost zprávy nikdy nevyprší. 300 je maximální hodnota. Pokud je tento parametr nenulový, služba, které klient nespotřebovává v rámci zadané hodnoty TTL, zahodí. Tento parametr může být užitečný v případě, že je šířka pásma klienta omezená.

Text požadavku

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

Name	Typ	Description
message	string (byte)	Tělo datové části.

Odpovědi

Name	Typ	Description
202 Accepted		Žádost byla přijata ke zpracování, ale zpracování ještě nebylo dokončeno.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Neočekávaná chybová odpověď Hlavičky x-ms-error-code: string

Zabezpečení

OAuth2Auth

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
https://webpubsub.azure.com/.default

Příklady

SendToConnection

Ukázkový požadavek

HTTP

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

"TWVzc2FnZSB0byBzZW5k"

Ukázková odpověď

Stavový kód:

202

Definice

Name	Description
Azure.Core.Foundations.Error	Objekt chyby.
Azure.Core.Foundations.ErrorResponse	Odpověď obsahující podrobnosti o chybě.
Azure.Core.Foundations.InnerError	Objekt obsahující konkrétnější informace o chybě. Podle Azure REST API – https://aka.ms/AzureRestApiGuidelines#handling-errors.

Azure.Core.Foundations.Error

Objekt

Objekt chyby.

Name	Typ	Description
code	string	Jedna ze serverově definovaných kódů chyb.
details	Azure.Core.Foundations.Error[]	Pole podrobností o konkrétních chybách, které vedly k této nahlášené chybě.
innererror	Azure.Core.Foundations.InnerError	Objekt obsahující konkrétnější informace, než je aktuální objekt o chybě.
message	string	Čitelné znázornění chyby člověkem.
target	string	Cíl chyby.

Azure.Core.Foundations.ErrorResponse

Objekt

Odpověď obsahující podrobnosti o chybě.

Name	Typ	Description
error	Azure.Core.Foundations.Error	Objekt chyby.

Azure.Core.Foundations.InnerError

Objekt

Objekt obsahující konkrétnější informace o chybě. Podle Azure REST API – https://aka.ms/AzureRestApiGuidelines#handling-errors.

Name	Typ	Description
code	string	Jedna ze serverově definovaných kódů chyb.
innererror	Azure.Core.Foundations.InnerError	Vnitřní chyba.