Rest-API des Azure SignalR-Diensts
Artikel 10/24/2023
1 Mitwirkender
Feedback
In diesem Artikel
Version: 2022-06-01
Verfügbare APIs
/api/health
HEAD
Zusammenfassung
Dienststatus abrufen.
Dienststatus abrufen
HEAD /api/health
Parameter
Name
Enthalten in
Beschreibung
Erforderlich
Schema
api-version
Abfrage
Die Version der REST-APIs.
Ja
Zeichenfolge
Antworten
Code
BESCHREIBUNG
200
Der Dienst ist integer.
default
Fehlerantwort
/api/hubs/{hub}/:close Verbinden ions
POST
Zusammenfassung
Schließen Sie alle Verbindungen im Hub.
Schließen aller Verbindungen im Hub
POST /api/hubs/{hub}/:closeConnections
Parameter
Name
Enthalten in
Beschreibung
Erforderlich
Schema
Hub
path
Name des Zielhubs. Muss mit alphabetischen Zeichen beginnen und darf nur alphanumerische Zeichen oder Unterstriche enthalten.
Ja
Zeichenfolge
anwendung
Abfrage
Zielanwendungsname, der mit alphabetischen Zeichen beginnen und nur alphanumerische Zeichen oder Unterstriche enthalten soll.
Nein
Zeichenfolge
excluded
Abfrage
Schließen Sie diese connectionIds aus, wenn Sie die Verbindungen im Hub schließen.
Nein
[ Zeichenfolge ]
reason
Abfrage
Der Grund zum Schließen der Clientverbindungen.
Nein
Zeichenfolge
api-version
Abfrage
Die Version der REST-APIs.
Ja
Zeichenfolge
Antworten
Code
Beschreibung
Schema
204
Erfolg
default
Fehlerantwort
ErrorDetail
/api/hubs/{hub}/:send
POST
Zusammenfassung
Übertragen einer Nachricht an alle Clients, die mit dem Zielhub verbunden sind
Übertragen einer Nachricht an alle Clients, die mit dem Zielhub verbunden sind
POST /api/hubs/{hub}/:send
Parameter
Name
Enthalten in
Beschreibung
Erforderlich
Schema
Hub
path
Name des Zielhubs. Muss mit alphabetischen Zeichen beginnen und darf nur alphanumerische Zeichen oder Unterstriche enthalten.
Ja
Zeichenfolge
anwendung
Abfrage
Zielanwendungsname, der mit alphabetischen Zeichen beginnen und nur alphanumerische Zeichen oder Unterstriche enthalten soll.
Nein
Zeichenfolge
excluded
Abfrage
Ausgeschlossene Verbindungs-IDs
Nein
[ Zeichenfolge ]
api-version
Abfrage
Die Version der REST-APIs.
Ja
Zeichenfolge
Nachricht
Text
Die Nutzlastmeldung.
Ja
PayloadMessage
Antworten
/api/hubs/{hub}/connections/{connectionId}
HEAD
Zusammenfassung
Überprüfen, ob die Verbindung mit der angegebenen Verbindungs-ID vorhanden ist
Überprüfen, ob die Verbindung mit der angegebenen Verbindungs-ID vorhanden ist
HEAD /api/hubs/{hub}/connections/{connectionId}
Parameter
Name
Enthalten in
Beschreibung
Erforderlich
Schema
Hub
path
Name des Zielhubs. Muss mit alphabetischen Zeichen beginnen und darf nur alphanumerische Zeichen oder Unterstriche enthalten.
Ja
Zeichenfolge
connectionId
path
Die Verbindungs-ID.
Ja
Zeichenfolge
anwendung
Abfrage
Zielanwendungsname, der mit alphabetischen Zeichen beginnen und nur alphanumerische Zeichen oder Unterstriche enthalten soll.
Nein
Zeichenfolge
api-version
Abfrage
Die Version der REST-APIs.
Ja
Zeichenfolge
Antworten
ENTF
Zusammenfassung
Schließen der Clientverbindung
Schließen der Clientverbindung
DELETE /api/hubs/{hub}/connections/{connectionId}
Parameter
Name
Enthalten in
Beschreibung
Erforderlich
Schema
Hub
path
Name des Zielhubs. Muss mit alphabetischen Zeichen beginnen und darf nur alphanumerische Zeichen oder Unterstriche enthalten.
Ja
Zeichenfolge
connectionId
path
Die Verbindungs-ID.
Ja
Zeichenfolge
anwendung
Abfrage
Zielanwendungsname, der mit alphabetischen Zeichen beginnen und nur alphanumerische Zeichen oder Unterstriche enthalten soll.
Nein
Zeichenfolge
reason
Abfrage
Der Grund für das Schließen der Verbindung.
Nein
Zeichenfolge
api-version
Abfrage
Die Version der REST-APIs.
Ja
Zeichenfolge
Antworten
/api/hubs/{hub}/connections/{connectionId}/:send
POST
Zusammenfassung
Senden einer Nachricht an die spezifische Verbindung
Nachricht an die bestimmte Verbindung senden
POST /api/hubs/{hub}/connections/{connectionId}/:send
Parameter
Name
Enthalten in
Beschreibung
Erforderlich
Schema
Hub
path
Name des Zielhubs. Muss mit alphabetischen Zeichen beginnen und darf nur alphanumerische Zeichen oder Unterstriche enthalten.
Ja
Zeichenfolge
connectionId
path
Die Verbindungs-ID.
Ja
Zeichenfolge
anwendung
Abfrage
Zielanwendungsname, der mit alphabetischen Zeichen beginnen und nur alphanumerische Zeichen oder Unterstriche enthalten soll.
Nein
Zeichenfolge
api-version
Abfrage
Die Version der REST-APIs.
Ja
Zeichenfolge
Nachricht
Text
Die Nutzlastmeldung.
Ja
PayloadMessage
Antworten
/api/hubs/{hub}/groups/{group}
HEAD
Zusammenfassung
Überprüfen, ob in der angegebenen Gruppe Clientverbindungen vorhanden sind
Überprüfen, ob in der angegebenen Gruppe Clientverbindungen vorhanden sind
HEAD /api/hubs/{hub}/groups/{group}
Parameter
Name
Enthalten in
Beschreibung
Erforderlich
Schema
Hub
path
Name des Zielhubs. Muss mit alphabetischen Zeichen beginnen und darf nur alphanumerische Zeichen oder Unterstriche enthalten.
Ja
Zeichenfolge
group
path
Name der Zielgruppe, deren Länge größer als 0 und kleiner als 1025 sein soll.
Ja
Zeichenfolge
anwendung
Abfrage
Zielanwendungsname, der mit alphabetischen Zeichen beginnen und nur alphanumerische Zeichen oder Unterstriche enthalten soll.
Nein
Zeichenfolge
api-version
Abfrage
Die Version der REST-APIs.
Ja
Zeichenfolge
Antworten
/api/hubs/{hub}/groups/{group}/:close Verbinden ions
POST
Zusammenfassung
Schließen Sie Verbindungen in der bestimmten Gruppe.
Schließen von Verbindungen in der bestimmten Gruppe
POST /api/hubs/{hub}/groups/{group}/:closeConnections
Parameter
Name
Enthalten in
Beschreibung
Erforderlich
Schema
Hub
path
Name des Zielhubs. Muss mit alphabetischen Zeichen beginnen und darf nur alphanumerische Zeichen oder Unterstriche enthalten.
Ja
Zeichenfolge
group
path
Name der Zielgruppe, deren Länge größer als 0 und kleiner als 1025 sein soll.
Ja
Zeichenfolge
anwendung
Abfrage
Zielanwendungsname, der mit alphabetischen Zeichen beginnen und nur alphanumerische Zeichen oder Unterstriche enthalten soll.
Nein
Zeichenfolge
excluded
Abfrage
Schließen Sie diese connectionIds aus, wenn Sie die Verbindungen im Hub schließen.
Nein
[ Zeichenfolge ]
reason
Abfrage
Der Grund zum Schließen der Clientverbindungen.
Nein
Zeichenfolge
api-version
Abfrage
Die Version der REST-APIs.
Ja
Zeichenfolge
Antworten
Code
Beschreibung
Schema
204
Erfolg
default
Fehlerantwort
ErrorDetail
/api/hubs/{hub}/groups/{group}/:send
POST
Zusammenfassung
Übertragen einer Nachricht an alle Clients innerhalb der Zielgruppe
Übertragen einer Nachricht an alle Clients innerhalb der Zielgruppe
POST /api/hubs/{hub}/groups/{group}/:send
Parameter
Name
Enthalten in
Beschreibung
Erforderlich
Schema
Hub
path
Name des Zielhubs. Muss mit alphabetischen Zeichen beginnen und darf nur alphanumerische Zeichen oder Unterstriche enthalten.
Ja
Zeichenfolge
group
path
Name der Zielgruppe, deren Länge größer als 0 und kleiner als 1025 sein soll.
Ja
Zeichenfolge
anwendung
Abfrage
Zielanwendungsname, der mit alphabetischen Zeichen beginnen und nur alphanumerische Zeichen oder Unterstriche enthalten soll.
Nein
Zeichenfolge
excluded
Abfrage
Ausgeschlossene Verbindungs-IDs
Nein
[ Zeichenfolge ]
api-version
Abfrage
Die Version der REST-APIs.
Ja
Zeichenfolge
Nachricht
Text
Die Nutzlastmeldung.
Ja
PayloadMessage
Antworten
/api/hubs/{hub}/groups/{group}/connections/{connectionId}
PUT
Zusammenfassung
Hinzufügen einer Verbindung zur Zielgruppe
Hinzufügen einer Verbindung zur Zielgruppe
PUT /api/hubs/{hub}/groups/{group}/connections/{connectionId}
Parameter
Name
Enthalten in
Beschreibung
Erforderlich
Schema
Hub
path
Name des Zielhubs. Muss mit alphabetischen Zeichen beginnen und darf nur alphanumerische Zeichen oder Unterstriche enthalten.
Ja
Zeichenfolge
group
path
Name der Zielgruppe, deren Länge größer als 0 und kleiner als 1025 sein soll.
Ja
Zeichenfolge
connectionId
path
Zielverbindungs-ID
Ja
Zeichenfolge
anwendung
Abfrage
Zielanwendungsname, der mit alphabetischen Zeichen beginnen und nur alphanumerische Zeichen oder Unterstriche enthalten soll.
Nein
Zeichenfolge
api-version
Abfrage
Die Version der REST-APIs.
Ja
Zeichenfolge
Antworten
ENTF
Zusammenfassung
Entfernen einer Verbindung aus der Zielgruppe
Entfernen einer Verbindung aus der Zielgruppe
DELETE /api/hubs/{hub}/groups/{group}/connections/{connectionId}
Parameter
Name
Enthalten in
Beschreibung
Erforderlich
Schema
Hub
path
Name des Zielhubs. Muss mit alphabetischen Zeichen beginnen und darf nur alphanumerische Zeichen oder Unterstriche enthalten.
Ja
Zeichenfolge
group
path
Name der Zielgruppe, deren Länge größer als 0 und kleiner als 1025 sein soll.
Ja
Zeichenfolge
connectionId
path
Zielverbindungs-ID
Ja
Zeichenfolge
anwendung
Abfrage
Zielanwendungsname, der mit alphabetischen Zeichen beginnen und nur alphanumerische Zeichen oder Unterstriche enthalten soll.
Nein
Zeichenfolge
api-version
Abfrage
Die Version der REST-APIs.
Ja
Zeichenfolge
Antworten
/api/hubs/{hub}/connections/{connectionId}/groups
ENTF
Zusammenfassung
Entfernen einer Verbindung aus allen Gruppen
Entfernen einer Verbindung aus allen Gruppen
DELETE /api/hubs/{hub}/connections/{connectionId}/groups
Parameter
Name
Enthalten in
Beschreibung
Erforderlich
Schema
Hub
path
Name des Zielhubs. Muss mit alphabetischen Zeichen beginnen und darf nur alphanumerische Zeichen oder Unterstriche enthalten.
Ja
Zeichenfolge
connectionId
path
Zielverbindungs-ID
Ja
Zeichenfolge
anwendung
Abfrage
Zielanwendungsname, der mit alphabetischen Zeichen beginnen und nur alphanumerische Zeichen oder Unterstriche enthalten soll.
Nein
Zeichenfolge
api-version
Abfrage
Die Version der REST-APIs.
Ja
Zeichenfolge
Antworten
/api/hubs/{hub}/users/{user}
HEAD
Zusammenfassung
Überprüfen, ob für den angegebenen Benutzer Clientverbindungen verbunden sind
Überprüfen, ob für den angegebenen Benutzer Clientverbindungen verbunden sind
HEAD /api/hubs/{hub}/users/{user}
Parameter
Name
Enthalten in
Beschreibung
Erforderlich
Schema
Hub
path
Name des Zielhubs. Muss mit alphabetischen Zeichen beginnen und darf nur alphanumerische Zeichen oder Unterstriche enthalten.
Ja
Zeichenfolge
user
path
Die Benutzer-ID.
Ja
Zeichenfolge
anwendung
Abfrage
Zielanwendungsname, der mit alphabetischen Zeichen beginnen und nur alphanumerische Zeichen oder Unterstriche enthalten soll.
Nein
Zeichenfolge
api-version
Abfrage
Die Version der REST-APIs.
Ja
Zeichenfolge
Antworten
/api/hubs/{hub}/users/{user}/:close Verbinden ions
POST
Zusammenfassung
Schließen Sie Verbindungen für den jeweiligen Benutzer.
Schließen von Verbindungen für den bestimmten Benutzer
POST /api/hubs/{hub}/users/{user}/:closeConnections
Parameter
Name
Enthalten in
Beschreibung
Erforderlich
Schema
Hub
path
Name des Zielhubs. Muss mit alphabetischen Zeichen beginnen und darf nur alphanumerische Zeichen oder Unterstriche enthalten.
Ja
Zeichenfolge
user
path
Die Benutzer-ID.
Ja
Zeichenfolge
anwendung
Abfrage
Zielanwendungsname, der mit alphabetischen Zeichen beginnen und nur alphanumerische Zeichen oder Unterstriche enthalten soll.
Nein
Zeichenfolge
excluded
Abfrage
Schließen Sie diese connectionIds aus, wenn Sie die Verbindungen im Hub schließen.
Nein
[ Zeichenfolge ]
reason
Abfrage
Der Grund zum Schließen der Clientverbindungen.
Nein
Zeichenfolge
api-version
Abfrage
Die Version der REST-APIs.
Ja
Zeichenfolge
Antworten
Code
Beschreibung
Schema
204
Erfolg
default
Fehlerantwort
ErrorDetail
/api/hubs/{hub}/users/{user}/:send
POST
Zusammenfassung
Übertragen einer Nachricht an alle Clients des Zielbenutzers
Übertragen einer Nachricht an alle Clients, die dem Zielbenutzer angehören
POST /api/hubs/{hub}/users/{user}/:send
Parameter
Name
Enthalten in
Beschreibung
Erforderlich
Schema
Hub
path
Name des Zielhubs. Muss mit alphabetischen Zeichen beginnen und darf nur alphanumerische Zeichen oder Unterstriche enthalten.
Ja
Zeichenfolge
user
path
Die Benutzer-ID.
Ja
Zeichenfolge
anwendung
Abfrage
Zielanwendungsname, der mit alphabetischen Zeichen beginnen und nur alphanumerische Zeichen oder Unterstriche enthalten soll.
Nein
Zeichenfolge
api-version
Abfrage
Die Version der REST-APIs.
Ja
Zeichenfolge
Nachricht
Text
Die Nutzlastmeldung.
Ja
PayloadMessage
Antworten
/api/hubs/{hub}/users/{user}/groups/{group}
HEAD
Zusammenfassung
Überprüfen, ob ein Benutzer in der Zielgruppe vorhanden ist
Überprüfen, ob ein Benutzer in der Zielgruppe vorhanden ist
HEAD /api/hubs/{hub}/users/{user}/groups/{group}
Parameter
Name
Enthalten in
Beschreibung
Erforderlich
Schema
Hub
path
Name des Zielhubs. Muss mit alphabetischen Zeichen beginnen und darf nur alphanumerische Zeichen oder Unterstriche enthalten.
Ja
Zeichenfolge
group
path
Name der Zielgruppe, deren Länge größer als 0 und kleiner als 1025 sein soll.
Ja
Zeichenfolge
user
path
Zielbenutzer-ID
Ja
Zeichenfolge
anwendung
Abfrage
Zielanwendungsname, der mit alphabetischen Zeichen beginnen und nur alphanumerische Zeichen oder Unterstriche enthalten soll.
Nein
Zeichenfolge
api-version
Abfrage
Die Version der REST-APIs.
Ja
Zeichenfolge
Antworten
PUT
Zusammenfassung
Hinzufügen eines Benutzers zur Zielgruppe
Hinzufügen eines Benutzers zur Zielgruppe
PUT /api/hubs/{hub}/users/{user}/groups/{group}
Parameter
Name
Enthalten in
Beschreibung
Erforderlich
Schema
Hub
path
Name des Zielhubs. Muss mit alphabetischen Zeichen beginnen und darf nur alphanumerische Zeichen oder Unterstriche enthalten.
Ja
Zeichenfolge
group
path
Name der Zielgruppe, deren Länge größer als 0 und kleiner als 1025 sein soll.
Ja
Zeichenfolge
user
path
Zielbenutzer-ID
Ja
Zeichenfolge
anwendung
Abfrage
Zielanwendungsname, der mit alphabetischen Zeichen beginnen und nur alphanumerische Zeichen oder Unterstriche enthalten soll.
Nein
Zeichenfolge
ttl
Abfrage
Gibt an, wie lange der Benutzer in der Gruppe vorhanden sein soll (in Sekunden). Wenn nicht festgelegt, befindet sich der Benutzer höchstens 1 Jahr lang in der Gruppe. Wenn ein Benutzer zu einigen Gruppen ohne Einschränkung hinzugefügt wird, werden nur die neuesten aktualisierten 100 Gruppen für alle Gruppen reserviert, die der Benutzer ohne TTL beigetreten ist. Wenn ttl = 0, werden nur die aktuellen verbundenen Verbindungen des Zielbenutzers zur Zielgruppe hinzugefügt.
Nein
integer
api-version
Abfrage
Die Version der REST-APIs.
Ja
Zeichenfolge
Antworten
ENTF
Zusammenfassung
Entfernen eines Benutzers aus der Zielgruppe
Entfernen eines Benutzers aus der Zielgruppe
DELETE /api/hubs/{hub}/users/{user}/groups/{group}
Parameter
Name
Enthalten in
Beschreibung
Erforderlich
Schema
Hub
path
Name des Zielhubs. Muss mit alphabetischen Zeichen beginnen und darf nur alphanumerische Zeichen oder Unterstriche enthalten.
Ja
Zeichenfolge
group
path
Name der Zielgruppe, deren Länge größer als 0 und kleiner als 1025 sein soll.
Ja
Zeichenfolge
user
path
Zielbenutzer-ID
Ja
Zeichenfolge
anwendung
Abfrage
Zielanwendungsname, der mit alphabetischen Zeichen beginnen und nur alphanumerische Zeichen oder Unterstriche enthalten soll.
Nein
Zeichenfolge
api-version
Abfrage
Die Version der REST-APIs.
Ja
Zeichenfolge
Antworten
Code
Beschreibung
Schema
204
Erfolg
default
Fehlerantwort
ErrorDetail
/api/hubs/{hub}/users/{user}/groups
ENTF
Zusammenfassung
Entfernen eines Benutzers aus allen Gruppen
Entfernen eines Benutzers aus allen Gruppen
DELETE /api/hubs/{hub}/users/{user}/groups
Parameter
Name
Enthalten in
Beschreibung
Erforderlich
Schema
Hub
path
Name des Zielhubs. Muss mit alphabetischen Zeichen beginnen und darf nur alphanumerische Zeichen oder Unterstriche enthalten.
Ja
Zeichenfolge
user
path
Zielbenutzer-ID
Ja
Zeichenfolge
anwendung
Abfrage
Zielanwendungsname, der mit alphabetischen Zeichen beginnen und nur alphanumerische Zeichen oder Unterstriche enthalten soll.
Nein
Zeichenfolge
api-version
Abfrage
Die Version der REST-APIs.
Ja
Zeichenfolge
Antworten
Code
Beschreibung
Schema
204
Erfolg
default
Fehlerantwort
ErrorDetail
Modelle
ErrorDetail
Das Fehlerobjekt.
Name
Typ
Beschreibung
Erforderlich
code
Zeichenfolge
Eine serverdefinierte Gruppe von Fehlercodes.
Nein
message
Zeichenfolge
Eine lesbare Darstellung des Fehlers.
Nein
target
Zeichenfolge
Das Ziel des Fehlers.
Nein
details
[ ErrorDetail ]
Ein Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.
Nein
inner
InnerError Nein
InnerError
Name
Typ
Beschreibung
Erforderlich
code
Zeichenfolge
Ein spezifischerer Fehlercode als vom enthaltenden Fehler bereitgestellt wurde.
Nein
inner
InnerError Nein
PayloadMessage
Name
Typ
Beschreibung
Erforderlich
target
Zeichenfolge
Ja
Argumente
[ ]
Nein
ServiceResponse
Name
Typ
Beschreibung
Erforderlich
code
string
Nein
Level
Zeichenfolge
Enumeration: "Info", , "Warning""Error"Nein
scope
Zeichenfolge
Enumeration: "Unknown", "Request", "Connection", "User""Group"Nein
errorKind
Zeichenfolge
Enumeration: "Unknown", "NotExisted", "NotInGroup""Invalid"Nein
message
Zeichenfolge
Nein
Jsonobject
Nein
IsSuccess
boolean
Nein