Partager via

Web Pub Sub - Send To All

  • Référence
Service:
Azure Web PubSub Service
Version d'API:
2024-01-01

Diffusez du contenu à l’intérieur du corps de la demande pour toutes les connexions clientes connectées.

POST {endpoint}/api/hubs/{hub}/:send?api-version=2024-01-01
Avec des paramètres facultatifs: 
POST {endpoint}/api/hubs/{hub}/:send?excluded={excluded}&api-version=2024-01-01&filter={filter}&messageTtlSeconds={messageTtlSeconds}

Paramètres URI

Nom Dans Obligatoire Type Description
endpoint
 path True

string

url

Point de terminaison HTTP ou HTTPS pour l’instance de service Web PubSub.
hub
 path True

string

Nom du hub cible, qui doit commencer par des caractères alphabétiques et ne contient que des caractères alphanumériques ou un trait de soulignement.

Modèle d’expression régulière: ^[A-Za-z][A-Za-z0-9_`,.[\]]{0,127}$
api-version
 query True

string

Version des API REST.
excluded
 query

string[]

ID de connexion exclus.
filter
 query

string

Après la syntaxe de filtre OData pour filtrer les abonnés qui reçoivent les messages.
messageTtlSeconds
 query

integer

int32

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 correspond à la valeur maximale. Si ce paramètre n’est pas égal à zéro, les messages qui ne sont pas consommés par le client dans la durée de vie spécifiée sont supprimés par le service. Ce paramètre peut vous aider lorsque la bande passante du client est limitée.

Corps de la demande

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

Nom Type Description
message

string

Corps de la charge utile.

Réponses

Nom Type Description
202 Accepted

Le message est accepté. Le service suit le modèle fire-and-forget lors de l’envoi de messages.
Other Status Codes

ErrorDetail

Réponse d’erreur

En-têtes

x-ms-error-code: string

Exemples

WebPubSub_SendToAll

Exemple de requête

POST {endpoint}/api/hubs/hub1/:send?api-version=2024-01-01&filter=startswith(userId, 'listener-')&messageTtlSeconds=15

"Message to send"

Exemple de réponse

Code d’état:
202

Définitions

Nom Description
ErrorDetail

Objet d’erreur.
InnerError

ErrorDetail

Objet d’erreur.

Nom Type Description
code

string

Un ensemble de codes d’erreur définis par le serveur.
details

ErrorDetail[]

Tableau de détails sur des erreurs spécifiques qui ont conduit à cette erreur signalée.
inner

InnerError

message

string

Représentation lisible par l’homme de l’erreur.
target

string

Cible de l’erreur.

InnerError

Nom Type Description
code

string

Code d’erreur plus spécifique que fourni par l’erreur contenante.
inner

InnerError