Send To Connection - Send To Connection

Tjänst:

Azure Web PubSub Service

API-version:

2024-12-01

Skicka innehåll i begärandetexten till den specifika anslutningen.

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

Med valfria parametrar:

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
connectionId	path	True	string minLength: 1	Anslutnings-ID:t.
endpoint	path	True	string (uri)	HTTP- eller HTTPS-slutpunkt för Web PubSub-tjänstinstansen
hub	path	True	string pattern: ^[A-Za-z][A-Za-z0-9_`,.[\]]{0,127}$	Målhubbens namn, som ska börja med alfabetiska tecken och endast innehålla alfanumeriska tecken eller understreck.
api-version	query	True	string minLength: 1	Den API-version som ska användas för den här åtgärden.
messageTtlSeconds	query		integer (int32) maximum: 300	TTL-värdet (Time-To-Live) i sekunder för meddelanden som skickas till tjänsten. 0 är standardvärdet, vilket innebär att meddelandet aldrig upphör att gälla. 300 är det maximala värdet. Om den här parametern inte är noll tas meddelanden som inte används av klienten inom det angivna TTL-värdet bort av tjänsten. Den här parametern kan vara till hjälp när klientens bandbredd är begränsad.

Begärandetext

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

Name	Typ	Description
message	string (byte)	Lastkroppen.

Svar

Name	Typ	Description
204 No Content		Det finns inget innehåll att skicka för den här begäran, men rubrikerna kan vara användbara.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Ett oväntat felsvar. Sidhuvuden x-ms-error-code: string

Säkerhet

OAuth2Auth

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

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

Exempel

SendToConnection

Exempelbegäran

HTTP

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

"TWVzc2FnZSB0byBzZW5k"

Exempelsvar

Statuskod:

204

Definitioner

Name	Description
Azure.Core.Foundations.Error	Felet objektet.
Azure.Core.Foundations.ErrorResponse	Ett svar som innehåller felinformation.
Azure.Core.Foundations.InnerError	Ett objekt som innehåller mer specifik information om felet. Enligt riktlinjerna för Azure REST API – https://aka.ms/AzureRestApiGuidelines#handling-errors.

Azure.Core.Foundations.Error

Objekt

Felet objektet.

Name	Typ	Description
code	string	En av en serverdefinierad uppsättning felkoder.
details	Azure.Core.Foundations.Error[]	En matris med information om specifika fel som ledde till det rapporterade felet.
innererror	Azure.Core.Foundations.InnerError	Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.
message	string	En mänsklig läsbar representation av felet.
target	string	Målet för felet.

Azure.Core.Foundations.ErrorResponse

Objekt

Ett svar som innehåller felinformation.

Name	Typ	Description
error	Azure.Core.Foundations.Error	Felet objektet.

Azure.Core.Foundations.InnerError

Objekt

Ett objekt som innehåller mer specifik information om felet. Enligt riktlinjerna för Azure REST API – https://aka.ms/AzureRestApiGuidelines#handling-errors.

Name	Typ	Description
code	string	En av en serverdefinierad uppsättning felkoder.
innererror	Azure.Core.Foundations.InnerError	Inre fel.