Teilen über

REST-API für die Azure SignalR Service-Datenebene: v1

  • Artikel

Dieser Artikel enthält Informationen zur Version v1 der REST-APIs für die Azure SignalR Service-Datenebene.

Verfügbare APIs

API Pfad
Übertragen einer Nachricht an alle Clients, die mit dem Zielhub verbunden sind POST /api/v1/hubs/{hub}
Übertragen einer Nachricht an alle Clients des Zielbenutzers POST /api/v1/hubs/{hub}/users/{id}
Senden einer Nachricht an die spezifische Verbindung POST /api/v1/hubs/{hub}/connections/{connectionId}
Überprüfen, ob die Verbindung mit der angegebenen Verbindungs-ID vorhanden ist GET /api/v1/hubs/{hub}/connections/{connectionId}
Schließen der Clientverbindung DELETE /api/v1/hubs/{hub}/connections/{connectionId}
Übertragen einer Nachricht an alle Clients innerhalb der Zielgruppe POST /api/v1/hubs/{hub}/groups/{group}
Überprüfen, ob in der angegebenen Gruppe Clientverbindungen vorhanden sind GET /api/v1/hubs/{hub}/groups/{group}
Überprüfen, ob für den angegebenen Benutzer Clientverbindungen verbunden sind GET /api/v1/hubs/{hub}/users/{user}
Hinzufügen einer Verbindung zur Zielgruppe PUT /api/v1/hubs/{hub}/groups/{group}/connections/{connectionId}
Entfernen einer Verbindung aus der Zielgruppe DELETE /api/v1/hubs/{hub}/groups/{group}/connections/{connectionId}
Überprüfen, ob ein Benutzer in der Zielgruppe vorhanden ist GET /api/v1/hubs/{hub}/groups/{group}/users/{user}
Hinzufügen eines Benutzers zur Zielgruppe PUT /api/v1/hubs/{hub}/groups/{group}/users/{user}
Entfernen eines Benutzers aus der Zielgruppe DELETE /api/v1/hubs/{hub}/groups/{group}/users/{user}
Entfernen eines Benutzers aus allen Gruppen DELETE /api/v1/hubs/{hub}/users/{user}/groups

Übertragen einer Nachricht an alle Clients, die mit dem Zielhub verbunden sind

POST /api/v1/hubs/{hub}

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
excluded Abfrage Ausgeschlossene Verbindungs-IDs Nein [ Zeichenfolge ]
Antworten
Code Beschreibung
202 Erfolg
400 Ungültige Anforderung

Übertragen einer Nachricht an alle Clients des Zielbenutzers

POST /api/v1/hubs/{hub}/users/{id}

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
id path Die Benutzer-ID. Ja Zeichenfolge
Antworten
Code Beschreibung
202 Erfolg
400 Ungültige Anforderung

Senden einer Nachricht an die spezifische Verbindung

POST /api/v1/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
Antworten
Code Beschreibung
202 Erfolg
400 Ungültige Anforderung

Überprüfen, ob die Verbindung mit der angegebenen Verbindungs-ID vorhanden ist

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

Parameter
Name Enthalten in Beschreibung Erforderlich Schema
Hub path Ja Zeichenfolge
connectionId path Ja Zeichenfolge
Antworten
Code BESCHREIBUNG
200 Erfolg
400 Ungültige Anforderung
404 Nicht gefunden

Schließen der Clientverbindung

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

Parameter
Name Enthalten in Beschreibung Erforderlich Schema
Hub path Ja Zeichenfolge
connectionId path Ja Zeichenfolge
reason Abfrage Nein Zeichenfolge
Antworten
Code Beschreibung
202 Erfolg
400 Ungültige Anforderung

Übertragen einer Nachricht an alle Clients innerhalb der Zielgruppe

POST /api/v1/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 mit einer Länge von mindestens einem Zeichen und weniger als 1.025 Zeichen. Ja Zeichenfolge
excluded Abfrage Ausgeschlossene Verbindungs-IDs Nein [ Zeichenfolge ]
Antworten
Code Beschreibung
202 Erfolg
400 Ungültige Anforderung

Überprüfen, ob in der angegebenen Gruppe Clientverbindungen vorhanden sind

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

Parameter
Name Enthalten in Beschreibung Erforderlich Schema
Hub path Ja Zeichenfolge
group path Ja Zeichenfolge
Antworten
Code BESCHREIBUNG
200 Erfolg
400 Ungültige Anforderung
404 Nicht gefunden

Überprüfen, ob für den angegebenen Benutzer Clientverbindungen verbunden sind

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

Parameter
Name Enthalten in Beschreibung Erforderlich Schema
Hub path Ja Zeichenfolge
user path Ja Zeichenfolge
Antworten
Code BESCHREIBUNG
200 Erfolg
400 Ungültige Anforderung
404 Nicht gefunden

Hinzufügen einer Verbindung zur Zielgruppe

PUT /api/v1/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 mit einer Länge von mindestens einem Zeichen und weniger als 1.025 Zeichen. Ja Zeichenfolge
connectionId path Zielverbindungs-ID Ja Zeichenfolge
Antworten
Code BESCHREIBUNG
200 Erfolg
400 Ungültige Anforderung
404 Nicht gefunden

Entfernen einer Verbindung aus der Zielgruppe

DELETE /api/v1/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 mit einer Länge von mindestens einem Zeichen und weniger als 1.025 Zeichen. Ja Zeichenfolge
connectionId path Zielverbindungs-ID Ja Zeichenfolge
Antworten
Code BESCHREIBUNG
200 Erfolg
400 Ungültige Anforderung
404 Nicht gefunden

Überprüfen, ob ein Benutzer in der Zielgruppe vorhanden ist

GET /api/v1/hubs/{hub}/groups/{group}/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
group path Name der Zielgruppe mit einer Länge von mindestens einem Zeichen und weniger als 1.025 Zeichen. Ja Zeichenfolge
user path Zielbenutzer-ID Ja Zeichenfolge
Antworten
Code BESCHREIBUNG
200 Erfolg
400 Ungültige Anforderung
404 Nicht gefunden

Hinzufügen eines Benutzers zur Zielgruppe

PUT /api/v1/hubs/{hub}/groups/{group}/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
group path Name der Zielgruppe mit einer Länge von mindestens einem Zeichen und weniger als 1.025 Zeichen. Ja Zeichenfolge
user path Zielbenutzer-ID Ja Zeichenfolge
ttl Abfrage Gibt an, wie lange der Benutzer in der Gruppe vorhanden sein soll (in Sekunden). Wird dieser Wert nicht festgelegt, bleibt der Benutzer maximal ein Jahr lang in der Gruppe. Hinweis: Wenn TTL nicht festgelegt wird, speichert der Dienst 100 Benutzergruppenbeziehungen pro Benutzer, und alte Benutzergruppenbeziehungen werden durch neu hinzugefügte überschrieben. Nein integer
Antworten
Code Beschreibung
202 Erfolg
400 Ungültige Anforderung

Entfernen eines Benutzers aus der Zielgruppe

DELETE /api/v1/hubs/{hub}/groups/{group}/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
group path Name der Zielgruppe mit einer Länge von mindestens einem Zeichen und weniger als 1.025 Zeichen. Ja Zeichenfolge
user path Zielbenutzer-ID Ja Zeichenfolge
Antworten
Code Beschreibung
202 Erfolg
400 Ungültige Anforderung

Entfernen eines Benutzers aus allen Gruppen

DELETE /api/v1/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
Antworten
Code BESCHREIBUNG
200 Der Benutzer wurde gelöscht.
202 Die Löschanforderung wurde akzeptiert und wird im Hintergrund verarbeitet.
400 Ungültige Anforderung

Modelle

PayloadMessage

Name Typ Beschreibung Erforderlich
Ziel Zeichenfolge Nein
Argumente [ Objekt ] Nein