Azure SignalR Service REST API

  • Article

Version : 2022-06-01

API disponibles

API Chemin d’accès
Obtenez l’état d’intégrité du service. HEAD /api/health
Fermez toutes les connexions dans le hub. POST /api/hubs/{hub}/:closeConnections
Diffuser un message à tous les clients connectés au hub cible. POST /api/hubs/{hub}/:send
Vérifier si la connexion avec le connectionId donné existe HEAD /api/hubs/{hub}/connections/{connectionId}
Fermer la connexion cliente DELETE /api/hubs/{hub}/connections/{connectionId}
Envoyer un message à la connexion spécifique. POST /api/hubs/{hub}/connections/{connectionId}/:send
Vérifier s’il existe des connexions clientes dans le groupe donné HEAD /api/hubs/{hub}/groups/{group}
Fermez les connexions dans le groupe spécifique. POST /api/hubs/{hub}/groups/{group}/:closeConnections
Diffuser un message à tous les clients au sein du groupe cible. POST /api/hubs/{hub}/groups/{group}/:send
Ajouter une connexion au groupe cible. PUT /api/hubs/{hub}/groups/{group}/connections/{connectionId}
Supprimer une connexion du groupe cible. DELETE /api/hubs/{hub}/groups/{group}/connections/{connectionId}
Supprimer une connexion de tous les groupes DELETE /api/hubs/{hub}/connections/{connectionId}/groups
Vérifier s’il existe des connexions clientes connectées pour l’utilisateur donné HEAD /api/hubs/{hub}/users/{user}
Fermez les connexions pour l’utilisateur spécifique. POST /api/hubs/{hub}/users/{user}/:closeConnections
Diffuser un message à tous les clients appartenant à l’utilisateur cible. POST /api/hubs/{hub}/users/{user}/:send
Vérifier si un utilisateur existe dans le groupe cible. HEAD /api/hubs/{hub}/users/{user}/groups/{group}
Ajouter un utilisateur au groupe cible. PUT /api/hubs/{hub}/users/{user}/groups/{group}
Supprimer un utilisateur du groupe cible. DELETE /api/hubs/{hub}/users/{user}/groups/{group}
Supprimer un utilisateur de tous les groupes. DELETE /api/hubs/{hub}/users/{user}/groups

/api/health

Résumé

Obtenez l’état d’intégrité du service.

Obtenir l’état d’intégrité du service

HEAD /api/health

Paramètres
Nom Emplacement Description Obligatoire schéma
api-version query Version des API REST. Oui string
Réponses
Code Description
200 Le service est sain
default Réponse d’erreur

/api/hubs/{hub}/ :close Connecter ions

POST

Résumé

Fermez toutes les connexions dans le hub.

Fermer toutes les connexions dans le hub

POST /api/hubs/{hub}/:closeConnections

Paramètres
Nom Emplacement Description Obligatoire schéma
hub path Nom du hub cible qui doit commencer par des caractères alphabétiques et ne contenir que des caractères alphanumériques ou traits de soulignement. Oui string
d'entreprise query Nom de l’application cible, qui doit commencer par des caractères alphabétiques et ne contient que des caractères alphanumériques ou un trait de soulignement. Non string
exclu query Excluez ces id de connexion lors de la fermeture des connexions dans le hub. Non [ string ]
reason query Raison de la fermeture des connexions clientes. Non string
api-version query Version des API REST. Oui string
Réponses
Code Description schéma
204 Opération réussie
default Réponse d’erreur ErrorDetail

/api/hubs/{hub}/ :send

POST

Résumé

Diffuser un message à tous les clients connectés au hub cible.

Diffuser un message à tous les clients connectés au hub cible

POST /api/hubs/{hub}/:send

Paramètres
Nom Emplacement Description Obligatoire schéma
hub path Nom du hub cible qui doit commencer par des caractères alphabétiques et ne contenir que des caractères alphanumériques ou traits de soulignement. Oui string
d'entreprise query Nom de l’application cible, qui doit commencer par des caractères alphabétiques et ne contient que des caractères alphanumériques ou un trait de soulignement. Non string
exclu query ID de connexion exclus Non [ string ]
api-version query Version des API REST. Oui string
message corps Message de charge utile. Oui PayloadMessage
Réponses
Code Description schéma
202 Opération réussie ServiceResponse
default Réponse d’erreur ErrorDetail

/api/hubs/{hub}/connections/{connectionId}

HEAD

Résumé

Vérifier si la connexion avec le connectionId donné existe

Vérifier si la connexion avec le connectionId donné existe

HEAD /api/hubs/{hub}/connections/{connectionId}

Paramètres
Nom Emplacement Description Obligatoire schéma
hub path Nom du hub cible qui doit commencer par des caractères alphabétiques et ne contenir que des caractères alphanumériques ou traits de soulignement. Oui string
connectionId path ID de connexion. Oui string
d'entreprise query Nom de l’application cible, qui doit commencer par des caractères alphabétiques et ne contient que des caractères alphanumériques ou un trait de soulignement. Non string
api-version query Version des API REST. Oui string
Réponses
Code Description schéma
200 Succès ServiceResponse
default Réponse d’erreur ErrorDetail

Suppression

Résumé

Fermer la connexion cliente

Fermer la connexion cliente

DELETE /api/hubs/{hub}/connections/{connectionId}

Paramètres
Nom Emplacement Description Obligatoire schéma
hub path Nom du hub cible qui doit commencer par des caractères alphabétiques et ne contenir que des caractères alphanumériques ou traits de soulignement. Oui string
connectionId path ID de connexion. Oui string
d'entreprise query Nom de l’application cible, qui doit commencer par des caractères alphabétiques et ne contient que des caractères alphanumériques ou un trait de soulignement. Non string
reason query Raison de la fermeture de la connexion. Non string
api-version query Version des API REST. Oui string
Réponses
Code Description schéma
200 Succès ServiceResponse
default Réponse d’erreur ErrorDetail

/api/hubs/{hub}/connections/{connectionId}/ :send

POST

Résumé

Envoyer un message à la connexion spécifique.

Envoyer un message à la connexion spécifique

POST /api/hubs/{hub}/connections/{connectionId}/:send

Paramètres
Nom Emplacement Description Obligatoire schéma
hub path Nom du hub cible qui doit commencer par des caractères alphabétiques et ne contenir que des caractères alphanumériques ou traits de soulignement. Oui string
connectionId path ID de connexion. Oui string
d'entreprise query Nom de l’application cible, qui doit commencer par des caractères alphabétiques et ne contient que des caractères alphanumériques ou un trait de soulignement. Non string
api-version query Version des API REST. Oui string
message corps Message de charge utile. Oui PayloadMessage
Réponses
Code Description schéma
202 Opération réussie ServiceResponse
default Réponse d’erreur ErrorDetail

/api/hubs/{hub}/groups/{group}

HEAD

Résumé

Vérifier s’il existe des connexions clientes dans le groupe donné

Vérifier s’il existe des connexions clientes dans le groupe donné

HEAD /api/hubs/{hub}/groups/{group}

Paramètres
Nom Emplacement Description Obligatoire schéma
hub path Nom du hub cible qui doit commencer par des caractères alphabétiques et ne contenir que des caractères alphanumériques ou traits de soulignement. Oui string
groupe path Nom du groupe cible, dont la longueur doit être supérieure à 0 et inférieure à 1025. Oui string
d'entreprise query Nom de l’application cible, qui doit commencer par des caractères alphabétiques et ne contient que des caractères alphanumériques ou un trait de soulignement. Non string
api-version query Version des API REST. Oui string
Réponses
Code Description schéma
200 Succès ServiceResponse
404 Introuvable
default Réponse d’erreur ErrorDetail

/api/hubs/{hub}/groups/{group}/ :close Connecter ions

POST

Résumé

Fermez les connexions dans le groupe spécifique.

Fermer les connexions dans le groupe spécifique

POST /api/hubs/{hub}/groups/{group}/:closeConnections

Paramètres
Nom Emplacement Description Obligatoire schéma
hub path Nom du hub cible qui doit commencer par des caractères alphabétiques et ne contenir que des caractères alphanumériques ou traits de soulignement. Oui string
groupe path Nom du groupe cible, dont la longueur doit être supérieure à 0 et inférieure à 1025. Oui string
d'entreprise query Nom de l’application cible, qui doit commencer par des caractères alphabétiques et ne contient que des caractères alphanumériques ou un trait de soulignement. Non string
exclu query Excluez ces id de connexion lors de la fermeture des connexions dans le hub. Non [ string ]
reason query Raison de la fermeture des connexions clientes. Non string
api-version query Version des API REST. Oui string
Réponses
Code Description schéma
204 Opération réussie
default Réponse d’erreur ErrorDetail

/api/hubs/{hub}/groups/{group}/ :send

POST

Résumé

Diffuser un message à tous les clients au sein du groupe cible.

Diffuser un message à tous les clients au sein du groupe cible

POST /api/hubs/{hub}/groups/{group}/:send

Paramètres
Nom Emplacement Description Obligatoire schéma
hub path Nom du hub cible qui doit commencer par des caractères alphabétiques et ne contenir que des caractères alphanumériques ou traits de soulignement. Oui string
groupe path Nom du groupe cible, dont la longueur doit être supérieure à 0 et inférieure à 1025. Oui string
d'entreprise query Nom de l’application cible, qui doit commencer par des caractères alphabétiques et ne contient que des caractères alphanumériques ou un trait de soulignement. Non string
exclu query ID de connexion exclus Non [ string ]
api-version query Version des API REST. Oui string
message corps Message de charge utile. Oui PayloadMessage
Réponses
Code Description schéma
202 Opération réussie ServiceResponse
default Réponse d’erreur ErrorDetail

/api/hubs/{hub}/groups/{group}/connections/{connectionId}

PUT

Résumé

Ajouter une connexion au groupe cible.

Ajouter une connexion au groupe cible

PUT /api/hubs/{hub}/groups/{group}/connections/{connectionId}

Paramètres
Nom Emplacement Description Obligatoire schéma
hub path Nom du hub cible qui doit commencer par des caractères alphabétiques et ne contenir que des caractères alphanumériques ou traits de soulignement. Oui string
groupe path Nom du groupe cible, dont la longueur doit être supérieure à 0 et inférieure à 1025. Oui string
connectionId path ID de connexion cible Oui string
d'entreprise query Nom de l’application cible, qui doit commencer par des caractères alphabétiques et ne contient que des caractères alphanumériques ou un trait de soulignement. Non string
api-version query Version des API REST. Oui string
Réponses
Code Description schéma
200 Succès ServiceResponse
404 Introuvable
default Réponse d’erreur ErrorDetail

Suppression

Résumé

Supprimer une connexion du groupe cible.

Supprimer une connexion du groupe cible

DELETE /api/hubs/{hub}/groups/{group}/connections/{connectionId}

Paramètres
Nom Emplacement Description Obligatoire schéma
hub path Nom du hub cible qui doit commencer par des caractères alphabétiques et ne contenir que des caractères alphanumériques ou traits de soulignement. Oui string
groupe path Nom du groupe cible, dont la longueur doit être supérieure à 0 et inférieure à 1025. Oui string
connectionId path ID de connexion cible Oui string
d'entreprise query Nom de l’application cible, qui doit commencer par des caractères alphabétiques et ne contient que des caractères alphanumériques ou un trait de soulignement. Non string
api-version query Version des API REST. Oui string
Réponses
Code Description schéma
200 Succès ServiceResponse
404 Introuvable
default Réponse d’erreur ErrorDetail

/api/hubs/{hub}/connections/{connectionId}/groups

Suppression

Résumé

Supprimer une connexion de tous les groupes

Supprimer une connexion de tous les groupes

DELETE /api/hubs/{hub}/connections/{connectionId}/groups

Paramètres
Nom Emplacement Description Obligatoire schéma
hub path Nom du hub cible qui doit commencer par des caractères alphabétiques et ne contenir que des caractères alphanumériques ou traits de soulignement. Oui string
connectionId path ID de connexion cible Oui string
d'entreprise query Nom de l’application cible, qui doit commencer par des caractères alphabétiques et ne contient que des caractères alphanumériques ou un trait de soulignement. Non string
api-version query Version des API REST. Oui string
Réponses
Code Description schéma
200 Succès ServiceResponse
default Réponse d’erreur ErrorDetail

/api/hubs/{hub}/users/{user}

HEAD

Résumé

Vérifier s’il existe des connexions clientes connectées pour l’utilisateur donné

Vérifier s’il existe des connexions clientes connectées pour l’utilisateur donné

HEAD /api/hubs/{hub}/users/{user}

Paramètres
Nom Emplacement Description Obligatoire schéma
hub path Nom du hub cible qui doit commencer par des caractères alphabétiques et ne contenir que des caractères alphanumériques ou traits de soulignement. Oui string
utilisateur path ID utilisateur. Oui string
d'entreprise query Nom de l’application cible, qui doit commencer par des caractères alphabétiques et ne contient que des caractères alphanumériques ou un trait de soulignement. Non string
api-version query Version des API REST. Oui string
Réponses
Code Description schéma
200 Succès ServiceResponse
404 Introuvable
default Réponse d’erreur ErrorDetail

/api/hubs/{hub}/users/{user}/ :close Connecter ions

POST

Résumé

Fermez les connexions pour l’utilisateur spécifique.

Fermer les connexions pour l’utilisateur spécifique

POST /api/hubs/{hub}/users/{user}/:closeConnections

Paramètres
Nom Emplacement Description Obligatoire schéma
hub path Nom du hub cible qui doit commencer par des caractères alphabétiques et ne contenir que des caractères alphanumériques ou traits de soulignement. Oui string
utilisateur path ID utilisateur. Oui string
d'entreprise query Nom de l’application cible, qui doit commencer par des caractères alphabétiques et ne contient que des caractères alphanumériques ou un trait de soulignement. Non string
exclu query Excluez ces id de connexion lors de la fermeture des connexions dans le hub. Non [ string ]
reason query Raison de la fermeture des connexions clientes. Non string
api-version query Version des API REST. Oui string
Réponses
Code Description schéma
204 Opération réussie
default Réponse d’erreur ErrorDetail

/api/hubs/{hub}/users/{user}/ :send

POST

Résumé

Diffuser un message à tous les clients appartenant à l’utilisateur cible.

Diffuser un message à tous les clients appartient à l’utilisateur cible

POST /api/hubs/{hub}/users/{user}/:send

Paramètres
Nom Emplacement Description Obligatoire schéma
hub path Nom du hub cible qui doit commencer par des caractères alphabétiques et ne contenir que des caractères alphanumériques ou traits de soulignement. Oui string
utilisateur path ID utilisateur. Oui string
d'entreprise query Nom de l’application cible, qui doit commencer par des caractères alphabétiques et ne contient que des caractères alphanumériques ou un trait de soulignement. Non string
api-version query Version des API REST. Oui string
message corps Message de charge utile. Oui PayloadMessage
Réponses
Code Description schéma
202 Opération réussie ServiceResponse
default Réponse d’erreur ErrorDetail

/api/hubs/{hub}/users/{user}/groups/{group}

HEAD

Résumé

Vérifier si un utilisateur existe dans le groupe cible.

Vérifier si un utilisateur existe dans le groupe cible

HEAD /api/hubs/{hub}/users/{user}/groups/{group}

Paramètres
Nom Emplacement Description Obligatoire schéma
hub path Nom du hub cible qui doit commencer par des caractères alphabétiques et ne contenir que des caractères alphanumériques ou traits de soulignement. Oui string
groupe path Nom du groupe cible, dont la longueur doit être supérieure à 0 et inférieure à 1025. Oui string
utilisateur path ID utilisateur cible Oui string
d'entreprise query Nom de l’application cible, qui doit commencer par des caractères alphabétiques et ne contient que des caractères alphanumériques ou un trait de soulignement. Non string
api-version query Version des API REST. Oui string
Réponses
Code Description schéma
200 Succès ServiceResponse
404 Introuvable
default Réponse d’erreur ErrorDetail

PUT

Résumé

Ajouter un utilisateur au groupe cible.

Ajouter un utilisateur au groupe cible

PUT /api/hubs/{hub}/users/{user}/groups/{group}

Paramètres
Nom Emplacement Description Obligatoire schéma
hub path Nom du hub cible qui doit commencer par des caractères alphabétiques et ne contenir que des caractères alphanumériques ou traits de soulignement. Oui string
groupe path Nom du groupe cible, dont la longueur doit être supérieure à 0 et inférieure à 1025. Oui string
utilisateur path ID utilisateur cible Oui string
d'entreprise query Nom de l’application cible, qui doit commencer par des caractères alphabétiques et ne contient que des caractères alphanumériques ou un trait de soulignement. Non string
ttl query Spécifie les secondes pendant lesquelles l’utilisateur existe dans le groupe. S’il n’est pas défini, l’utilisateur vit dans le groupe pendant 1 an au maximum. Si un utilisateur est ajouté à certains groupes sans limitation de durée de vie, seuls les 100 groupes mis à jour les plus récents seront réservés parmi tous les groupes joints par l’utilisateur sans durée de vie. Si ttl = 0, seules les connexions connectées actuelles de l’utilisateur cible sont ajoutées au groupe cible. Non entier
api-version query Version des API REST. Oui string
Réponses
Code Description schéma
200 Succès ServiceResponse
default Réponse d’erreur ErrorDetail

Suppression

Résumé

Supprimer un utilisateur du groupe cible.

Supprimer un utilisateur du groupe cible

DELETE /api/hubs/{hub}/users/{user}/groups/{group}

Paramètres
Nom Emplacement Description Obligatoire schéma
hub path Nom du hub cible qui doit commencer par des caractères alphabétiques et ne contenir que des caractères alphanumériques ou traits de soulignement. Oui string
groupe path Nom du groupe cible, dont la longueur doit être supérieure à 0 et inférieure à 1025. Oui string
utilisateur path ID utilisateur cible Oui string
d'entreprise query Nom de l’application cible, qui doit commencer par des caractères alphabétiques et ne contient que des caractères alphanumériques ou un trait de soulignement. Non string
api-version query Version des API REST. Oui string
Réponses
Code Description schéma
204 Opération réussie
default Réponse d’erreur ErrorDetail

/api/hubs/{hub}/users/{user}/groups

Suppression

Résumé

Supprimer un utilisateur de tous les groupes.

Supprimer un utilisateur de tous les groupes

DELETE /api/hubs/{hub}/users/{user}/groups

Paramètres
Nom Emplacement Description Obligatoire schéma
hub path Nom du hub cible qui doit commencer par des caractères alphabétiques et ne contenir que des caractères alphanumériques ou traits de soulignement. Oui string
utilisateur path ID utilisateur cible Oui string
d'entreprise query Nom de l’application cible, qui doit commencer par des caractères alphabétiques et ne contient que des caractères alphanumériques ou un trait de soulignement. Non string
api-version query Version des API REST. Oui string
Réponses
Code Description schéma
204 Opération réussie
default Réponse d’erreur ErrorDetail

Modèles

ErrorDetail

Objet d’erreur.

Nom Type Description Obligatoire
code string Un ensemble de codes d’erreur définis par le serveur. Non
message string Représentation lisible par l’homme de l’erreur. Non
cible string Cible de l’erreur. Non
details [ ErrorDetail ] Tableau de détails sur des erreurs spécifiques qui ont conduit à cette erreur signalée. Non
inner InnerError Non

InnerError

Nom Type Description Obligatoire
code string Code d’erreur plus spécifique que fourni par l’erreur contenante. Non
inner InnerError Non

PayloadMessage

Nom Type Description Obligatoire
cible string Oui
arguments [ ] Non

ServiceResponse

Nom Type Description Obligatoire
code string Non
level string Enum :"Info", "Warning", "Error" Non
scope string Enum :"Unknown", "Request", , "User""Connection","Group" Non
errorKind string Enum :"Unknown", "NotExisted", , "NotInGroup""Invalid" Non
message string Non
Jsonobject Non
isSuccess boolean Non