Send To Connection - Send To Connection

Service:

Azure Web PubSub Service

Version d'API:

2024-12-01

Envoyez le contenu dans le corps de la demande à la connexion spécifique.

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

Avec des paramètres facultatifs:

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
connectionId	path	True	string minLength: 1	La connexion Id.
endpoint	path	True	string (uri)	Point de terminaison HTTP ou HTTPS pour l’instance de service Web PubSub
hub	path	True	string pattern: ^[A-Za-z][A-Za-z0-9_`,.[\]]{0,127}$	Nom du hub cible, qui doit commencer par des caractères alphabétiques et ne contenir que des caractères alphanumériques ou des traits de soulignement.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.
messageTtlSeconds	query		integer (int32) maximum: 300	Valeur de durée de vie (TTL) en secondes pour les messages envoyés au service. 0 est la valeur par défaut, ce qui signifie que le message n’expire jamais. 300 est la valeur maximale. Si ce paramètre est différent de zéro, les messages qui ne sont pas consommés par le client dans la durée de vie spécifiée seront supprimés par le service. Ce paramètre peut être utile lorsque la bande passante du client est limitée.

Corps de la demande

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

Nom	Type	Description
message	string (byte)	Le corps de la charge utile.

Réponses

Nom	Type	Description
204 No Content		Il n’y a pas de contenu à envoyer pour cette demande, mais les en-têtes peuvent être utiles.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Réponse d’erreur inattendue. En-têtes x-ms-error-code: string

Sécurité

OAuth2Auth

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

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

Exemples

SendToConnection

Exemple de requête

HTTP

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

"TWVzc2FnZSB0byBzZW5k"

Exemple de réponse

Code d’état:

204

Définitions

Nom	Description
Azure.Core.Foundations.Error	Objet d’erreur.
Azure.Core.Foundations.ErrorResponse	Une réponse contenant les détails de l’erreur.
Azure.Core.Foundations.InnerError	Objet contenant des informations plus spécifiques sur l’erreur. Conformément aux directives de l’API REST Azure : https://aka.ms/AzureRestApiGuidelines#handling-errors.

Azure.Core.Foundations.Error

Object

Objet d’erreur.

Nom	Type	Description
code	string	Un ensemble de codes d’erreur définis par le serveur.
details	Azure.Core.Foundations.Error[]	Tableau de détails sur des erreurs spécifiques qui ont conduit à cette erreur signalée.
innererror	Azure.Core.Foundations.InnerError	Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur.
message	string	Représentation lisible par l’homme de l’erreur.
target	string	Cible de l’erreur.

Azure.Core.Foundations.ErrorResponse

Object

Une réponse contenant les détails de l’erreur.

Nom	Type	Description
error	Azure.Core.Foundations.Error	Objet d’erreur.

Azure.Core.Foundations.InnerError

Object

Objet contenant des informations plus spécifiques sur l’erreur. Conformément aux directives de l’API REST Azure : https://aka.ms/AzureRestApiGuidelines#handling-errors.

Nom	Type	Description
code	string	Un ensemble de codes d’erreur définis par le serveur.
innererror	Azure.Core.Foundations.InnerError	Erreur intérieure.