API REST du plan de données Azure SignalR Service - v1
Article 24/10/2023
1 contributeur
Commentaires
Dans cet article
Cet article contient les API REST version v1 pour le plan de données Azure SignalR Service.
Agrandir le tableau
Diffuser un message à tous les clients connectés au hub cible.
POST /api/v1/hubs/{hub}
Agrandir le tableau
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
exclu
query
ID de connexion exclus
Non
[ string ]
Agrandir le tableau
Code
Description
202
Opération réussie
400
Demande incorrecte
Diffuser un message à tous les clients appartenant à l’utilisateur cible.
POST /api/v1/hubs/{hub}/users/{id}
Agrandir le tableau
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
id
path
ID utilisateur.
Oui
string
Agrandir le tableau
Code
Description
202
Opération réussie
400
Demande incorrecte
Envoyer un message à la connexion spécifique.
POST /api/v1/hubs/{hub}/connections/{connectionId}
Agrandir le tableau
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
Agrandir le tableau
Code
Description
202
Opération réussie
400
Demande incorrecte
Vérifier si la connexion avec le connectionId donné existe
GET /api/v1/hubs/{hub}/connections/{connectionId}
Agrandir le tableau
Nom
Emplacement
Description
Obligatoire
schéma
hub
path
Oui
string
connectionId
path
Oui
string
Agrandir le tableau
Code
Description
200
Succès
400
Demande incorrecte
404
Introuvable
Fermer la connexion cliente
DELETE /api/v1/hubs/{hub}/connections/{connectionId}
Agrandir le tableau
Nom
Emplacement
Description
Obligatoire
schéma
hub
path
Oui
string
connectionId
path
Oui
string
reason
query
Non
string
Agrandir le tableau
Code
Description
202
Opération réussie
400
Demande incorrecte
Diffuser un message à tous les clients au sein du groupe cible.
POST /api/v1/hubs/{hub}/groups/{group}
Agrandir le tableau
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 à 1 025.
Oui
string
exclu
query
ID de connexion exclus
Non
[ string ]
Agrandir le tableau
Code
Description
202
Opération réussie
400
Demande incorrecte
Vérifier s’il existe des connexions clientes dans le groupe donné
GET /api/v1/hubs/{hub}/groups/{group}
Agrandir le tableau
Nom
Emplacement
Description
Obligatoire
schéma
hub
path
Oui
string
groupe
path
Oui
string
Agrandir le tableau
Code
Description
200
Succès
400
Demande incorrecte
404
Introuvable
Vérifier s’il existe des connexions clientes connectées pour l’utilisateur donné
GET /api/v1/hubs/{hub}/users/{user}
Agrandir le tableau
Nom
Emplacement
Description
Obligatoire
schéma
hub
path
Oui
string
utilisateur
path
Oui
string
Agrandir le tableau
Code
Description
200
Succès
400
Demande incorrecte
404
Introuvable
Ajouter une connexion au groupe cible.
PUT /api/v1/hubs/{hub}/groups/{group}/connections/{connectionId}
Agrandir le tableau
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 à 1 025.
Oui
string
connectionId
path
ID de connexion cible
Oui
string
Agrandir le tableau
Code
Description
200
Succès
400
Demande incorrecte
404
Introuvable
Supprimer une connexion du groupe cible.
DELETE /api/v1/hubs/{hub}/groups/{group}/connections/{connectionId}
Agrandir le tableau
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 à 1 025.
Oui
string
connectionId
path
ID de connexion cible
Oui
string
Agrandir le tableau
Code
Description
200
Succès
400
Demande incorrecte
404
Introuvable
Vérifier si un utilisateur existe dans le groupe cible.
GET /api/v1/hubs/{hub}/groups/{group}/users/{user}
Agrandir le tableau
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 à 1 025.
Oui
string
utilisateur
path
ID utilisateur cible
Oui
string
Agrandir le tableau
Code
Description
200
Succès
400
Demande incorrecte
404
Introuvable
Ajouter un utilisateur au groupe cible.
PUT /api/v1/hubs/{hub}/groups/{group}/users/{user}
Agrandir le tableau
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 à 1 025.
Oui
string
utilisateur
path
ID utilisateur cible
Oui
string
ttl
query
Spécifie les secondes pendant lesquelles l’utilisateur existe dans le groupe. Si elle n’est pas définie, l’utilisateur vit dans le groupe pendant au plus 1 an. Notez que lorsque la durée de vie n’est pas définie, le service conserve 100 relations utilisateur-groupe par utilisateur et les anciennes relations utilisateur-groupe sont remplacées par les nouvelles qui sont ajoutées.
Non
entier
Agrandir le tableau
Code
Description
202
Opération réussie
400
Demande incorrecte
Supprimer un utilisateur du groupe cible.
DELETE /api/v1/hubs/{hub}/groups/{group}/users/{user}
Agrandir le tableau
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 à 1 025.
Oui
string
utilisateur
path
ID utilisateur cible
Oui
string
Agrandir le tableau
Code
Description
202
Opération réussie
400
Demande incorrecte
Supprimer un utilisateur de tous les groupes.
DELETE /api/v1/hubs/{hub}/users/{user}/groups
Agrandir le tableau
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
Agrandir le tableau
Code
Description
200
L’utilisateur est supprimé
202
La demande de suppression est acceptée et le service gère la demande en arrière-plan
400
Demande incorrecte
Agrandir le tableau
Nom
Type
Description
Obligatoire
Cible
string
Non
Arguments
[ object ]
Non