Udostępnij za pośrednictwem

Interfejs API REST płaszczyzny danych usługi Azure SignalR Service — wersja 1

  • Artykuł

Ten artykuł zawiera interfejsy API REST w wersji 1 dla płaszczyzny danych usługi Azure SignalR Service.

Dostępne interfejsy API

Interfejs API Ścieżka
Emisja komunikatu do wszystkich klientów połączonych z koncentratorem docelowym. POST /api/v1/hubs/{hub}
Emisja komunikatu do wszystkich klientów należy do użytkownika docelowego. POST /api/v1/hubs/{hub}/users/{id}
Wyślij komunikat do określonego połączenia. POST /api/v1/hubs/{hub}/connections/{connectionId}
Sprawdź, czy istnieje połączenie z danym identyfikatorem connectionId GET /api/v1/hubs/{hub}/connections/{connectionId}
Zamykanie połączenia klienta DELETE /api/v1/hubs/{hub}/connections/{connectionId}
Emisja komunikatu do wszystkich klientów w grupie docelowej. POST /api/v1/hubs/{hub}/groups/{group}
Sprawdź, czy w danej grupie istnieją jakiekolwiek połączenia klienckie GET /api/v1/hubs/{hub}/groups/{group}
Sprawdź, czy istnieją połączenia klienta połączone dla danego użytkownika GET /api/v1/hubs/{hub}/users/{user}
Dodaj połączenie z grupą docelową. PUT /api/v1/hubs/{hub}/groups/{group}/connections/{connectionId}
Usuń połączenie z grupy docelowej. DELETE /api/v1/hubs/{hub}/groups/{group}/connections/{connectionId}
Sprawdź, czy użytkownik istnieje w grupie docelowej. GET /api/v1/hubs/{hub}/groups/{group}/users/{user}
Dodaj użytkownika do grupy docelowej. PUT /api/v1/hubs/{hub}/groups/{group}/users/{user}
Usuń użytkownika z grupy docelowej. DELETE /api/v1/hubs/{hub}/groups/{group}/users/{user}
Usuń użytkownika ze wszystkich grup. DELETE /api/v1/hubs/{hub}/users/{user}/groups

Emisja komunikatu do wszystkich klientów połączonych z koncentratorem docelowym.

POST /api/v1/hubs/{hub}

Parametry
Nazwisko Znajduje się w opis Wymagania Schemat
Koncentratora path Nazwa centrum docelowego, która musi zaczynać się od znaków alfabetycznych i zawierać tylko znaki alfanumeryczne lub podkreślenie. Tak string
Wykluczone zapytanie Wykluczone identyfikatory połączeń Nie. [ ciąg ]
Odpowiedzi
Kod opis
202 Powodzenie
400 Nieprawidłowe żądanie

Emisja komunikatu do wszystkich klientów należy do użytkownika docelowego.

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

Parametry
Nazwisko Znajduje się w opis Wymagania Schemat
Koncentratora path Nazwa centrum docelowego, która musi zaczynać się od znaków alfabetycznych i zawierać tylko znaki alfanumeryczne lub podkreślenie. Tak string
identyfikator path Identyfikator użytkownika. Tak string
Odpowiedzi
Kod opis
202 Powodzenie
400 Nieprawidłowe żądanie

Wyślij komunikat do określonego połączenia.

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

Parametry
Nazwisko Znajduje się w opis Wymagania Schemat
Koncentratora path Nazwa centrum docelowego, która musi zaczynać się od znaków alfabetycznych i zawierać tylko znaki alfanumeryczne lub podkreślenie. Tak string
connectionId path Identyfikator połączenia. Tak string
Odpowiedzi
Kod opis
202 Powodzenie
400 Nieprawidłowe żądanie

Sprawdź, czy istnieje połączenie z danym identyfikatorem connectionId

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

Parametry
Nazwisko Znajduje się w opis Wymagania Schemat
Koncentratora path Tak string
connectionId path Tak string
Odpowiedzi
Kod opis
200 Sukces
400 Nieprawidłowe żądanie
404 Nie znaleziono

Zamykanie połączenia klienta

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

Parametry
Nazwisko Znajduje się w opis Wymagania Schemat
Koncentratora path Tak string
connectionId path Tak string
reason zapytanie Nie. string
Odpowiedzi
Kod opis
202 Powodzenie
400 Nieprawidłowe żądanie

Emisja komunikatu do wszystkich klientów w grupie docelowej.

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

Parametry
Nazwisko Znajduje się w opis Wymagania Schemat
Koncentratora path Nazwa centrum docelowego, która musi zaczynać się od znaków alfabetycznych i zawierać tylko znaki alfanumeryczne lub podkreślenie. Tak string
grupa path Nazwa grupy docelowej, której długość musi być większa niż 0 i mniejsza niż 1025. Tak string
Wykluczone zapytanie Wykluczone identyfikatory połączeń Nie. [ ciąg ]
Odpowiedzi
Kod opis
202 Powodzenie
400 Nieprawidłowe żądanie

Sprawdź, czy w danej grupie istnieją jakiekolwiek połączenia klienckie

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

Parametry
Nazwisko Znajduje się w opis Wymagania Schemat
Koncentratora path Tak string
grupa path Tak string
Odpowiedzi
Kod opis
200 Sukces
400 Nieprawidłowe żądanie
404 Nie znaleziono

Sprawdź, czy istnieją połączenia klienta połączone dla danego użytkownika

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

Parametry
Nazwisko Znajduje się w opis Wymagania Schemat
Koncentratora path Tak string
Użytkownik path Tak string
Odpowiedzi
Kod opis
200 Sukces
400 Nieprawidłowe żądanie
404 Nie znaleziono

Dodaj połączenie z grupą docelową.

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

Parametry
Nazwisko Znajduje się w opis Wymagania Schemat
Koncentratora path Nazwa centrum docelowego, która musi zaczynać się od znaków alfabetycznych i zawierać tylko znaki alfanumeryczne lub podkreślenie. Tak string
grupa path Nazwa grupy docelowej, której długość musi być większa niż 0 i mniejsza niż 1025. Tak string
connectionId path Identyfikator połączenia docelowego Tak string
Odpowiedzi
Kod opis
200 Sukces
400 Nieprawidłowe żądanie
404 Nie znaleziono

Usuń połączenie z grupy docelowej.

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

Parametry
Nazwisko Znajduje się w opis Wymagania Schemat
Koncentratora path Nazwa centrum docelowego, która musi zaczynać się od znaków alfabetycznych i zawierać tylko znaki alfanumeryczne lub podkreślenie. Tak string
grupa path Nazwa grupy docelowej, której długość musi być większa niż 0 i mniejsza niż 1025. Tak string
connectionId path Identyfikator połączenia docelowego Tak string
Odpowiedzi
Kod opis
200 Sukces
400 Nieprawidłowe żądanie
404 Nie znaleziono

Sprawdź, czy użytkownik istnieje w grupie docelowej.

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

Parametry
Nazwisko Znajduje się w opis Wymagania Schemat
Koncentratora path Nazwa centrum docelowego, która musi zaczynać się od znaków alfabetycznych i zawierać tylko znaki alfanumeryczne lub podkreślenie. Tak string
grupa path Nazwa grupy docelowej, której długość musi być większa niż 0 i mniejsza niż 1025. Tak string
Użytkownik path Identyfikator użytkownika docelowego Tak string
Odpowiedzi
Kod opis
200 Sukces
400 Nieprawidłowe żądanie
404 Nie znaleziono

Dodaj użytkownika do grupy docelowej.

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

Parametry
Nazwisko Znajduje się w opis Wymagania Schemat
Koncentratora path Nazwa centrum docelowego, która musi zaczynać się od znaków alfabetycznych i zawierać tylko znaki alfanumeryczne lub podkreślenie. Tak string
grupa path Nazwa grupy docelowej, której długość musi być większa niż 0 i mniejsza niż 1025. Tak string
Użytkownik path Identyfikator użytkownika docelowego Tak string
czas wygaśnięcia zapytanie Określa sekundy, w których użytkownik istnieje w grupie. Jeśli nie zostanie ustawiona, użytkownik mieszka w grupie przez co najwyżej 1 rok. Należy pamiętać, że jeśli czas wygaśnięcia nie jest ustawiony, usługa zachowuje 100 relacji grupy użytkowników na użytkownika i starej relacji grupy użytkowników są zastępowane przez nowo dodane. Nie. integer
Odpowiedzi
Kod opis
202 Powodzenie
400 Nieprawidłowe żądanie

Usuń użytkownika z grupy docelowej.

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

Parametry
Nazwisko Znajduje się w opis Wymagania Schemat
Koncentratora path Nazwa centrum docelowego, która musi zaczynać się od znaków alfabetycznych i zawierać tylko znaki alfanumeryczne lub podkreślenie. Tak string
grupa path Nazwa grupy docelowej, której długość musi być większa niż 0 i mniejsza niż 1025. Tak string
Użytkownik path Identyfikator użytkownika docelowego Tak string
Odpowiedzi
Kod opis
202 Powodzenie
400 Nieprawidłowe żądanie

Usuń użytkownika ze wszystkich grup.

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

Parametry
Nazwisko Znajduje się w opis Wymagania Schemat
Koncentratora path Nazwa centrum docelowego, która musi zaczynać się od znaków alfabetycznych i zawierać tylko znaki alfanumeryczne lub podkreślenie. Tak string
Użytkownik path Identyfikator użytkownika docelowego Tak string
Odpowiedzi
Kod opis
200 Użytkownik zostanie usunięty
202 Żądanie usunięcia jest akceptowane, a usługa obsługuje żądanie w tle
400 Nieprawidłowe żądanie

Modele

PayloadMessage

Imię i nazwisko/nazwa Pisz Opis Wymagania
Cel string Nie
Argumenty [ obiekt ] Nie.