Azure SignalR Service REST API
Artikel 07/03/2024
1 inzender
Feedback
In dit artikel
Versie: 2022-06-01
Beschikbare API's
/api/health
HEAD
Samenvatting
Status van de service ophalen.
Status van service ophalen
HEAD /api/health
Parameters
Naam
Gelegen in
Beschrijving
Vereist
Schema
api-versie
query
De versie van de REST API's.
Ja
tekenreeks
Antwoorden
Code
Beschrijving
200
De service is in orde
default
Foutrespons
/api/hubs/{hub}/:closeConnections
POSTEN
Samenvatting
Sluit alle verbindingen in de hub.
Alle verbindingen in de hub sluiten
POST /api/hubs/{hub}/:closeConnections
Parameters
Naam
Gelegen in
Beschrijving
Vereist
Schema
naaf
path
Doelhubnaam, die moet beginnen met alfabetische tekens en alleen alfanumerieke tekens of onderstrepingstekens bevatten.
Ja
tekenreeks
toepassing
query
Doeltoepassingsnaam, die moet beginnen met alfabetische tekens en alleen alfanumerieke tekens of onderstrepingstekens bevatten.
Nee
tekenreeks
Uitgesloten
query
Sluit deze connectionIds uit bij het sluiten van de verbindingen in de hub.
Nee
[ tekenreeks ]
reason
query
De reden voor het sluiten van de clientverbindingen.
Nee
tekenreeks
api-versie
query
De versie van de REST API's.
Ja
tekenreeks
Antwoorden
Code
Beschrijving
Schema
204
Geslaagd
default
Foutrespons
ErrorDetail
/api/hubs/{hub}/:send
POSTEN
Samenvatting
Een bericht uitzenden naar alle clients die zijn verbonden met de doelhub.
Een bericht uitzenden naar alle clients die zijn verbonden met de doelhub
POST /api/hubs/{hub}/:send
Parameters
Naam
Gelegen in
Beschrijving
Vereist
Schema
naaf
path
Doelhubnaam, die moet beginnen met alfabetische tekens en alleen alfanumerieke tekens of onderstrepingstekens bevatten.
Ja
tekenreeks
toepassing
query
Doeltoepassingsnaam, die moet beginnen met alfabetische tekens en alleen alfanumerieke tekens of onderstrepingstekens bevatten.
Nee
tekenreeks
Uitgesloten
query
Uitgesloten verbindings-id's
Nee
[ tekenreeks ]
api-versie
query
De versie van de REST API's.
Ja
tekenreeks
bericht
hoofdtekst
Het nettoladingbericht.
Ja
PayloadMessage
Antwoorden
/api/hubs/{hub}/connections/{connectionId}
HEAD
Samenvatting
Controleer of de verbinding met de opgegeven connectionId bestaat
Controleer of de verbinding met de opgegeven connectionId bestaat
HEAD /api/hubs/{hub}/connections/{connectionId}
Parameters
Naam
Gelegen in
Beschrijving
Vereist
Schema
naaf
path
Doelhubnaam, die moet beginnen met alfabetische tekens en alleen alfanumerieke tekens of onderstrepingstekens bevatten.
Ja
tekenreeks
connectionId
path
De verbindings-id.
Ja
tekenreeks
toepassing
query
Doeltoepassingsnaam, die moet beginnen met alfabetische tekens en alleen alfanumerieke tekens of onderstrepingstekens bevatten.
Nee
tekenreeks
api-versie
query
De versie van de REST API's.
Ja
tekenreeks
Antwoorden
DELETE
Samenvatting
Sluit de clientverbinding
Sluit de clientverbinding
DELETE /api/hubs/{hub}/connections/{connectionId}
Parameters
Naam
Gelegen in
Beschrijving
Vereist
Schema
naaf
path
Doelhubnaam, die moet beginnen met alfabetische tekens en alleen alfanumerieke tekens of onderstrepingstekens bevatten.
Ja
tekenreeks
connectionId
path
De verbindings-id.
Ja
tekenreeks
toepassing
query
Doeltoepassingsnaam, die moet beginnen met alfabetische tekens en alleen alfanumerieke tekens of onderstrepingstekens bevatten.
Nee
tekenreeks
reason
query
De reden van het sluiten van de verbinding.
Nee
tekenreeks
api-versie
query
De versie van de REST API's.
Ja
tekenreeks
Antwoorden
/api/hubs/{hub}/connections/{connectionId}/:send
POSTEN
Samenvatting
Verzend een bericht naar de specifieke verbinding.
Bericht verzenden naar de specifieke verbinding
POST /api/hubs/{hub}/connections/{connectionId}/:send
Parameters
Naam
Gelegen in
Beschrijving
Vereist
Schema
naaf
path
Doelhubnaam, die moet beginnen met alfabetische tekens en alleen alfanumerieke tekens of onderstrepingstekens bevatten.
Ja
tekenreeks
connectionId
path
De verbindings-id.
Ja
tekenreeks
toepassing
query
Doeltoepassingsnaam, die moet beginnen met alfabetische tekens en alleen alfanumerieke tekens of onderstrepingstekens bevatten.
Nee
tekenreeks
api-versie
query
De versie van de REST API's.
Ja
tekenreeks
bericht
hoofdtekst
Het nettoladingbericht.
Ja
PayloadMessage
Antwoorden
/api/hubs/{hub}/groups/{group}
HEAD
Samenvatting
Controleer of er clientverbindingen in de opgegeven groep zijn
Controleer of er clientverbindingen in de opgegeven groep zijn
HEAD /api/hubs/{hub}/groups/{group}
Parameters
Naam
Gelegen in
Beschrijving
Vereist
Schema
naaf
path
Doelhubnaam, die moet beginnen met alfabetische tekens en alleen alfanumerieke tekens of onderstrepingstekens bevatten.
Ja
tekenreeks
groeperen
path
Naam van de doelgroep, welke lengte groter moet zijn dan 0 en kleiner dan 1025.
Ja
tekenreeks
toepassing
query
Doeltoepassingsnaam, die moet beginnen met alfabetische tekens en alleen alfanumerieke tekens of onderstrepingstekens bevatten.
Nee
tekenreeks
api-versie
query
De versie van de REST API's.
Ja
tekenreeks
Antwoorden
/api/hubs/{hub}/groups/{group}/:closeConnections
POSTEN
Samenvatting
Sluit verbindingen in de specifieke groep.
Verbindingen in de specifieke groep sluiten
POST /api/hubs/{hub}/groups/{group}/:closeConnections
Parameters
Naam
Gelegen in
Beschrijving
Vereist
Schema
naaf
path
Doelhubnaam, die moet beginnen met alfabetische tekens en alleen alfanumerieke tekens of onderstrepingstekens bevatten.
Ja
tekenreeks
groeperen
path
Naam van de doelgroep, welke lengte groter moet zijn dan 0 en kleiner dan 1025.
Ja
tekenreeks
toepassing
query
Doeltoepassingsnaam, die moet beginnen met alfabetische tekens en alleen alfanumerieke tekens of onderstrepingstekens bevatten.
Nee
tekenreeks
Uitgesloten
query
Sluit deze connectionIds uit bij het sluiten van de verbindingen in de hub.
Nee
[ tekenreeks ]
reason
query
De reden voor het sluiten van de clientverbindingen.
Nee
tekenreeks
api-versie
query
De versie van de REST API's.
Ja
tekenreeks
Antwoorden
Code
Beschrijving
Schema
204
Geslaagd
default
Foutrespons
ErrorDetail
/api/hubs/{hub}/groups/{group}/:send
POSTEN
Samenvatting
Een bericht uitzenden naar alle clients binnen de doelgroep.
Een bericht uitzenden naar alle clients binnen de doelgroep
POST /api/hubs/{hub}/groups/{group}/:send
Parameters
Naam
Gelegen in
Beschrijving
Vereist
Schema
naaf
path
Doelhubnaam, die moet beginnen met alfabetische tekens en alleen alfanumerieke tekens of onderstrepingstekens bevatten.
Ja
tekenreeks
groeperen
path
Naam van de doelgroep, welke lengte groter moet zijn dan 0 en kleiner dan 1025.
Ja
tekenreeks
toepassing
query
Doeltoepassingsnaam, die moet beginnen met alfabetische tekens en alleen alfanumerieke tekens of onderstrepingstekens bevatten.
Nee
tekenreeks
Uitgesloten
query
Uitgesloten verbindings-id's
Nee
[ tekenreeks ]
api-versie
query
De versie van de REST API's.
Ja
tekenreeks
bericht
hoofdtekst
Het nettoladingbericht.
Ja
PayloadMessage
Antwoorden
/api/hubs/{hub}/groups/{group}/connections/{connectionId}
PUT
Samenvatting
Voeg een verbinding toe aan de doelgroep.
Een verbinding toevoegen aan de doelgroep
PUT /api/hubs/{hub}/groups/{group}/connections/{connectionId}
Parameters
Naam
Gelegen in
Beschrijving
Vereist
Schema
naaf
path
Doelhubnaam, die moet beginnen met alfabetische tekens en alleen alfanumerieke tekens of onderstrepingstekens bevatten.
Ja
tekenreeks
groeperen
path
Naam van de doelgroep, welke lengte groter moet zijn dan 0 en kleiner dan 1025.
Ja
tekenreeks
connectionId
path
Doelverbindings-id
Ja
tekenreeks
toepassing
query
Doeltoepassingsnaam, die moet beginnen met alfabetische tekens en alleen alfanumerieke tekens of onderstrepingstekens bevatten.
Nee
tekenreeks
api-versie
query
De versie van de REST API's.
Ja
tekenreeks
Antwoorden
DELETE
Samenvatting
Verwijder een verbinding uit de doelgroep.
Een verbinding uit de doelgroep verwijderen
DELETE /api/hubs/{hub}/groups/{group}/connections/{connectionId}
Parameters
Naam
Gelegen in
Beschrijving
Vereist
Schema
naaf
path
Doelhubnaam, die moet beginnen met alfabetische tekens en alleen alfanumerieke tekens of onderstrepingstekens bevatten.
Ja
tekenreeks
groeperen
path
Naam van de doelgroep, welke lengte groter moet zijn dan 0 en kleiner dan 1025.
Ja
tekenreeks
connectionId
path
Doelverbindings-id
Ja
tekenreeks
toepassing
query
Doeltoepassingsnaam, die moet beginnen met alfabetische tekens en alleen alfanumerieke tekens of onderstrepingstekens bevatten.
Nee
tekenreeks
api-versie
query
De versie van de REST API's.
Ja
tekenreeks
Antwoorden
/api/hubs/{hub}/connections/{connectionId}/groups
DELETE
Samenvatting
Een verbinding verwijderen uit alle groepen
Een verbinding verwijderen uit alle groepen
DELETE /api/hubs/{hub}/connections/{connectionId}/groups
Parameters
Naam
Gelegen in
Beschrijving
Vereist
Schema
naaf
path
Doelhubnaam, die moet beginnen met alfabetische tekens en alleen alfanumerieke tekens of onderstrepingstekens bevatten.
Ja
tekenreeks
connectionId
path
Doelverbindings-id
Ja
tekenreeks
toepassing
query
Doeltoepassingsnaam, die moet beginnen met alfabetische tekens en alleen alfanumerieke tekens of onderstrepingstekens bevatten.
Nee
tekenreeks
api-versie
query
De versie van de REST API's.
Ja
tekenreeks
Antwoorden
/api/hubs/{hub}/users/{user}
HEAD
Samenvatting
Controleer of er clientverbindingen zijn verbonden voor de opgegeven gebruiker
Controleer of er clientverbindingen zijn verbonden voor de opgegeven gebruiker
HEAD /api/hubs/{hub}/users/{user}
Parameters
Naam
Gelegen in
Beschrijving
Vereist
Schema
naaf
path
Doelhubnaam, die moet beginnen met alfabetische tekens en alleen alfanumerieke tekens of onderstrepingstekens bevatten.
Ja
tekenreeks
Gebruiker
path
De gebruikers-id.
Ja
tekenreeks
toepassing
query
Doeltoepassingsnaam, die moet beginnen met alfabetische tekens en alleen alfanumerieke tekens of onderstrepingstekens bevatten.
Nee
tekenreeks
api-versie
query
De versie van de REST API's.
Ja
tekenreeks
Antwoorden
/api/hubs/{hub}/users/{user}/:closeConnections
POSTEN
Samenvatting
Sluit verbindingen voor de specifieke gebruiker.
Verbindingen voor de specifieke gebruiker sluiten
POST /api/hubs/{hub}/users/{user}/:closeConnections
Parameters
Naam
Gelegen in
Beschrijving
Vereist
Schema
naaf
path
Doelhubnaam, die moet beginnen met alfabetische tekens en alleen alfanumerieke tekens of onderstrepingstekens bevatten.
Ja
tekenreeks
Gebruiker
path
De gebruikers-id.
Ja
tekenreeks
toepassing
query
Doeltoepassingsnaam, die moet beginnen met alfabetische tekens en alleen alfanumerieke tekens of onderstrepingstekens bevatten.
Nee
tekenreeks
Uitgesloten
query
Sluit deze connectionIds uit bij het sluiten van de verbindingen in de hub.
Nee
[ tekenreeks ]
reason
query
De reden voor het sluiten van de clientverbindingen.
Nee
tekenreeks
api-versie
query
De versie van de REST API's.
Ja
tekenreeks
Antwoorden
Code
Beschrijving
Schema
204
Geslaagd
default
Foutrespons
ErrorDetail
/api/hubs/{hub}/users/{user}/:send
POSTEN
Samenvatting
Een bericht uitzenden naar alle clients behoort tot de doelgebruiker.
Een bericht uitzenden naar alle clients behoort tot de doelgebruiker
POST /api/hubs/{hub}/users/{user}/:send
Parameters
Naam
Gelegen in
Beschrijving
Vereist
Schema
naaf
path
Doelhubnaam, die moet beginnen met alfabetische tekens en alleen alfanumerieke tekens of onderstrepingstekens bevatten.
Ja
tekenreeks
Gebruiker
path
De gebruikers-id.
Ja
tekenreeks
toepassing
query
Doeltoepassingsnaam, die moet beginnen met alfabetische tekens en alleen alfanumerieke tekens of onderstrepingstekens bevatten.
Nee
tekenreeks
api-versie
query
De versie van de REST API's.
Ja
tekenreeks
bericht
hoofdtekst
Het nettoladingbericht.
Ja
PayloadMessage
Antwoorden
/api/hubs/{hub}/users/{user}/groups/{group}
HEAD
Samenvatting
Controleer of een gebruiker in de doelgroep bestaat.
Controleren of een gebruiker bestaat in de doelgroep
HEAD /api/hubs/{hub}/users/{user}/groups/{group}
Parameters
Naam
Gelegen in
Beschrijving
Vereist
Schema
naaf
path
Doelhubnaam, die moet beginnen met alfabetische tekens en alleen alfanumerieke tekens of onderstrepingstekens bevatten.
Ja
tekenreeks
groeperen
path
Naam van de doelgroep, welke lengte groter moet zijn dan 0 en kleiner dan 1025.
Ja
tekenreeks
Gebruiker
path
Doelgebruikers-id
Ja
tekenreeks
toepassing
query
Doeltoepassingsnaam, die moet beginnen met alfabetische tekens en alleen alfanumerieke tekens of onderstrepingstekens bevatten.
Nee
tekenreeks
api-versie
query
De versie van de REST API's.
Ja
tekenreeks
Antwoorden
PUT
Samenvatting
Voeg een gebruiker toe aan de doelgroep.
Een gebruiker toevoegen aan de doelgroep
PUT /api/hubs/{hub}/users/{user}/groups/{group}
Parameters
Naam
Gelegen in
Beschrijving
Vereist
Schema
naaf
path
Doelhubnaam, die moet beginnen met alfabetische tekens en alleen alfanumerieke tekens of onderstrepingstekens bevatten.
Ja
tekenreeks
groeperen
path
Naam van de doelgroep, welke lengte groter moet zijn dan 0 en kleiner dan 1025.
Ja
tekenreeks
Gebruiker
path
Doelgebruikers-id
Ja
tekenreeks
toepassing
query
Doeltoepassingsnaam, die moet beginnen met alfabetische tekens en alleen alfanumerieke tekens of onderstrepingstekens bevatten.
Nee
tekenreeks
ttl
query
Hiermee geeft u de seconden op dat de gebruiker in de groep bestaat. Als deze optie niet is ingesteld, woont de gebruiker maximaal 1 jaar in de groep. Als een gebruiker wordt toegevoegd aan sommige groepen zonder ttl-beperking, worden alleen de meest recente bijgewerkte 100 groepen gereserveerd voor alle groepen die de gebruiker heeft toegevoegd zonder TTL. Als ttl = 0, worden alleen de huidige verbonden verbindingen van de doelgebruiker toegevoegd aan de doelgroep.
Nee
geheel getal
api-versie
query
De versie van de REST API's.
Ja
tekenreeks
Antwoorden
DELETE
Samenvatting
Verwijder een gebruiker uit de doelgroep.
Een gebruiker verwijderen uit de doelgroep
DELETE /api/hubs/{hub}/users/{user}/groups/{group}
Parameters
Naam
Gelegen in
Beschrijving
Vereist
Schema
naaf
path
Doelhubnaam, die moet beginnen met alfabetische tekens en alleen alfanumerieke tekens of onderstrepingstekens bevatten.
Ja
tekenreeks
groeperen
path
Naam van de doelgroep, welke lengte groter moet zijn dan 0 en kleiner dan 1025.
Ja
tekenreeks
Gebruiker
path
Doelgebruikers-id
Ja
tekenreeks
toepassing
query
Doeltoepassingsnaam, die moet beginnen met alfabetische tekens en alleen alfanumerieke tekens of onderstrepingstekens bevatten.
Nee
tekenreeks
api-versie
query
De versie van de REST API's.
Ja
tekenreeks
Antwoorden
Code
Beschrijving
Schema
204
Geslaagd
default
Foutrespons
ErrorDetail
/api/hubs/{hub}/users/{user}/groups
DELETE
Samenvatting
Een gebruiker uit alle groepen verwijderen.
Een gebruiker uit alle groepen verwijderen
DELETE /api/hubs/{hub}/users/{user}/groups
Parameters
Naam
Gelegen in
Beschrijving
Vereist
Schema
naaf
path
Doelhubnaam, die moet beginnen met alfabetische tekens en alleen alfanumerieke tekens of onderstrepingstekens bevatten.
Ja
tekenreeks
Gebruiker
path
Doelgebruikers-id
Ja
tekenreeks
toepassing
query
Doeltoepassingsnaam, die moet beginnen met alfabetische tekens en alleen alfanumerieke tekens of onderstrepingstekens bevatten.
Nee
tekenreeks
api-versie
query
De versie van de REST API's.
Ja
tekenreeks
Antwoorden
Code
Beschrijving
Schema
204
Geslaagd
default
Foutrespons
ErrorDetail
Modellen
ErrorDetail
Het foutobject.
Name
Type
Beschrijving
Vereist
code
tekenreeks
Een van een door de server gedefinieerde set foutcodes.
Nee
bericht
tekenreeks
Een leesbare weergave van de fout.
Nee
doel
tekenreeks
Het doel van de fout.
Nee
details
[ ErrorDetail ]
Een matrix met details over specifieke fouten die hebben geleid tot deze gemelde fout.
Nee
binnenste
InnerError Nee
InnerError
Name
Type
Beschrijving
Vereist
code
tekenreeks
Een specifiekere foutcode dan is opgegeven door de bijbehorende fout.
Nee
binnenste
InnerError Nee
PayloadMessage
Name
Type
Beschrijving
Vereist
doel
tekenreeks
Ja
Argumenten
[ ]
Nee
ServiceResponse
Name
Type
Beschrijving
Vereist
code
string
Nee
niveau
tekenreeks
Opsomming: "Info", "Warning""Error"Nee
bereik
tekenreeks
Opsomming: "Unknown", "Request", "Connection", , "User""Group"Nee
errorKind
tekenreeks
Opsomming: "Unknown", "NotExisted", , "NotInGroup""Invalid"Nee
bericht
tekenreeks
Nee
jsonObject
Nee
isSuccess
boolean
Nee