Send To Connection - Send To Connection

Service:

Azure Web PubSub Service

API-versie:

2024-12-01

Verzend inhoud in de aanvraagbody naar de specifieke verbinding.

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

Met optionele parameters:

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

URI-parameters

Name	In	Vereist	Type	Description
connectionId	path	True	string minLength: 1	De verbindings-id.
endpoint	path	True	string (uri)	HTTP- of HTTPS-eindpunt voor het exemplaar van de Web PubSub-service
hub	path	True	string pattern: ^[A-Za-z][A-Za-z0-9_`,.[\]]{0,127}$	Doelnaam van de hub, die moet beginnen met alfabetische tekens en alleen alfanumerieke tekens of onderstrepingsteken moet bevatten.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.
messageTtlSeconds	query		integer (int32) minimum: 0 maximum: 300	De time-to-live (TTL)-waarde in seconden voor berichten die naar de service worden verzonden. 0 is de standaardwaarde, wat betekent dat het bericht nooit verloopt. 300 is de maximale waarde. Als deze parameter niet nul is, worden berichten die niet door de client binnen de opgegeven TTL worden verbruikt, door de service verwijderd. Deze parameter kan helpen wanneer de bandbreedte van de client beperkt is.

Aanvraagbody

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

Name	Type	Description
message	string (byte)	De laadbak.

Antwoorden

Name	Type	Description
202 Accepted		De aanvraag is geaccepteerd voor verwerking, maar de verwerking is nog niet voltooid.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Een onverwachte foutreactie. Kopteksten x-ms-error-code: string

Beveiliging

OAuth2Auth

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

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

Voorbeelden

SendToConnection

Voorbeeldaanvraag

HTTP

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

"TWVzc2FnZSB0byBzZW5k"

Voorbeeldrespons

Statuscode:

202

Definities

Name	Description
Azure.Core.Foundations.Error	Het foutobject.
Azure.Core.Foundations.ErrorResponse	Een antwoord met foutdetails.
Azure.Core.Foundations.InnerError	Een object dat meer specifieke informatie over de fout bevat. Volgens Azure REST API-richtlijnen - https://aka.ms/AzureRestApiGuidelines#handling-errors.

Azure.Core.Foundations.Error

Object

Het foutobject.

Name	Type	Description
code	string	Een van een door de server gedefinieerde set foutcodes.
details	Azure.Core.Foundations.Error[]	Een matrix met details over specifieke fouten die hebben geleid tot deze gemelde fout.
innererror	Azure.Core.Foundations.InnerError	Een object met meer specifieke informatie dan het huidige object over de fout.
message	string	Een leesbare weergave van de fout.
target	string	Het doel van de fout.

Azure.Core.Foundations.ErrorResponse

Object

Een antwoord met foutdetails.

Name	Type	Description
error	Azure.Core.Foundations.Error	Het foutobject.

Azure.Core.Foundations.InnerError

Object

Een object dat meer specifieke informatie over de fout bevat. Volgens Azure REST API-richtlijnen - https://aka.ms/AzureRestApiGuidelines#handling-errors.

Name	Type	Description
code	string	Een van een door de server gedefinieerde set foutcodes.
innererror	Azure.Core.Foundations.InnerError	Innerlijke fout.