Azure SignalR Service REST API
Artykuł 07/03/2024
1 współautor
Opinia
W tym artykule
Wersja: 2022-06-01
Dostępne interfejsy API
/api/health
HEAD
Podsumowanie
Uzyskaj stan kondycji usługi.
Uzyskiwanie stanu kondycji usługi
HEAD /api/health
Parametry
Nazwisko
Znajduje się w
opis
Wymagania
Schemat
api-version
zapytanie
Wersja interfejsów API REST.
Tak
string
Odpowiedzi
Kod
opis
200
Usługa jest w dobrej kondycji
domyślna
Odpowiedź błędna
/api/hubs/{hub}/:closeConnections
POST
Podsumowanie
Zamknij wszystkie połączenia w centrum.
Zamknij wszystkie połączenia w centrum
POST /api/hubs/{hub}/:closeConnections
Parametry
Nazwisko
Znajduje się w
opis
Wymagania
Schemat
koncentrator
path
Nazwa centrum docelowego, która powinna zaczynać się od znaków alfabetycznych i zawierać tylko znaki alfanumeryczne lub podkreślenie.
Tak
string
aplikacja
zapytanie
Nazwa aplikacji docelowej, która powinna zaczynać się od znaków alfabetycznych i zawierać tylko znaki alfanumeryczne lub podkreślenie.
Nie.
string
Wykluczone
zapytanie
Wyklucz te identyfikatory connectionId podczas zamykania połączeń w centrum.
Nie.
[ ciąg ]
reason
zapytanie
Przyczyna zamknięcia połączeń klienta.
Nie.
string
api-version
zapytanie
Wersja interfejsów API REST.
Tak
string
Odpowiedzi
Kod
opis
Schemat
204
Powodzenie
domyślna
Odpowiedź błędna
ErrorDetail
/api/hubs/{hub}/:send
POST
Podsumowanie
Emisja komunikatu do wszystkich klientów połączonych z koncentratorem docelowym.
Emisja komunikatu do wszystkich klientów połączonych z koncentratorem docelowym
POST /api/hubs/{hub}/:send
Parametry
Nazwisko
Znajduje się w
opis
Wymagania
Schemat
koncentrator
path
Nazwa centrum docelowego, która powinna zaczynać się od znaków alfabetycznych i zawierać tylko znaki alfanumeryczne lub podkreślenie.
Tak
string
aplikacja
zapytanie
Nazwa aplikacji docelowej, która powinna zaczynać się od znaków alfabetycznych i zawierać tylko znaki alfanumeryczne lub podkreślenie.
Nie.
string
Wykluczone
zapytanie
Wykluczone identyfikatory połączeń
Nie.
[ ciąg ]
api-version
zapytanie
Wersja interfejsów API REST.
Tak
string
wiadomość
treść
Komunikat ładunku.
Tak
PayloadMessage
Odpowiedzi
/api/hubs/{hub}/connections/{connectionId}
HEAD
Podsumowanie
Sprawdź, czy istnieje połączenie z danym identyfikatorem connectionId
Sprawdź, czy istnieje połączenie z danym identyfikatorem connectionId
HEAD /api/hubs/{hub}/connections/{connectionId}
Parametry
Nazwisko
Znajduje się w
opis
Wymagania
Schemat
koncentrator
path
Nazwa centrum docelowego, która powinna zaczynać się od znaków alfabetycznych i zawierać tylko znaki alfanumeryczne lub podkreślenie.
Tak
string
connectionId
path
Identyfikator połączenia.
Tak
string
aplikacja
zapytanie
Nazwa aplikacji docelowej, która powinna zaczynać się od znaków alfabetycznych i zawierać tylko znaki alfanumeryczne lub podkreślenie.
Nie.
string
api-version
zapytanie
Wersja interfejsów API REST.
Tak
string
Odpowiedzi
DELETE
Podsumowanie
Zamykanie połączenia klienta
Zamykanie połączenia klienta
DELETE /api/hubs/{hub}/connections/{connectionId}
Parametry
Nazwisko
Znajduje się w
opis
Wymagania
Schemat
koncentrator
path
Nazwa centrum docelowego, która powinna zaczynać się od znaków alfabetycznych i zawierać tylko znaki alfanumeryczne lub podkreślenie.
Tak
string
connectionId
path
Identyfikator połączenia.
Tak
string
aplikacja
zapytanie
Nazwa aplikacji docelowej, która powinna zaczynać się od znaków alfabetycznych i zawierać tylko znaki alfanumeryczne lub podkreślenie.
Nie.
string
reason
zapytanie
Przyczyna zamknięcia połączenia.
Nie.
string
api-version
zapytanie
Wersja interfejsów API REST.
Tak
string
Odpowiedzi
/api/hubs/{hub}/connections/{connectionId}/:send
POST
Podsumowanie
Wyślij komunikat do określonego połączenia.
Wysyłanie komunikatu do określonego połączenia
POST /api/hubs/{hub}/connections/{connectionId}/:send
Parametry
Nazwisko
Znajduje się w
opis
Wymagania
Schemat
koncentrator
path
Nazwa centrum docelowego, która powinna zaczynać się od znaków alfabetycznych i zawierać tylko znaki alfanumeryczne lub podkreślenie.
Tak
string
connectionId
path
Identyfikator połączenia.
Tak
string
aplikacja
zapytanie
Nazwa aplikacji docelowej, która powinna zaczynać się od znaków alfabetycznych i zawierać tylko znaki alfanumeryczne lub podkreślenie.
Nie.
string
api-version
zapytanie
Wersja interfejsów API REST.
Tak
string
wiadomość
treść
Komunikat ładunku.
Tak
PayloadMessage
Odpowiedzi
/api/hubs/{hub}/groups/{group}
HEAD
Podsumowanie
Sprawdź, czy w danej grupie istnieją jakiekolwiek połączenia klienckie
Sprawdź, czy w danej grupie istnieją jakiekolwiek połączenia klienckie
HEAD /api/hubs/{hub}/groups/{group}
Parametry
Nazwisko
Znajduje się w
opis
Wymagania
Schemat
koncentrator
path
Nazwa centrum docelowego, która powinna zaczynać się od znaków alfabetycznych i zawierać tylko znaki alfanumeryczne lub podkreślenie.
Tak
string
grupa
path
Nazwa grupy docelowej, która długość powinna być większa niż 0 i mniejsza niż 1025.
Tak
string
aplikacja
zapytanie
Nazwa aplikacji docelowej, która powinna zaczynać się od znaków alfabetycznych i zawierać tylko znaki alfanumeryczne lub podkreślenie.
Nie.
string
api-version
zapytanie
Wersja interfejsów API REST.
Tak
string
Odpowiedzi
/api/hubs/{hub}/groups/{group}/:closeConnections
POST
Podsumowanie
Zamknij połączenia w określonej grupie.
Zamykanie połączeń w określonej grupie
POST /api/hubs/{hub}/groups/{group}/:closeConnections
Parametry
Nazwisko
Znajduje się w
opis
Wymagania
Schemat
koncentrator
path
Nazwa centrum docelowego, która powinna zaczynać się od znaków alfabetycznych i zawierać tylko znaki alfanumeryczne lub podkreślenie.
Tak
string
grupa
path
Nazwa grupy docelowej, która długość powinna być większa niż 0 i mniejsza niż 1025.
Tak
string
aplikacja
zapytanie
Nazwa aplikacji docelowej, która powinna zaczynać się od znaków alfabetycznych i zawierać tylko znaki alfanumeryczne lub podkreślenie.
Nie.
string
Wykluczone
zapytanie
Wyklucz te identyfikatory connectionId podczas zamykania połączeń w centrum.
Nie.
[ ciąg ]
reason
zapytanie
Przyczyna zamknięcia połączeń klienta.
Nie.
string
api-version
zapytanie
Wersja interfejsów API REST.
Tak
string
Odpowiedzi
Kod
opis
Schemat
204
Powodzenie
domyślna
Odpowiedź błędna
ErrorDetail
/api/hubs/{hub}/groups/{group}/:send
POST
Podsumowanie
Emisja komunikatu do wszystkich klientów w grupie docelowej.
Emisja komunikatu do wszystkich klientów w grupie docelowej
POST /api/hubs/{hub}/groups/{group}/:send
Parametry
Nazwisko
Znajduje się w
opis
Wymagania
Schemat
koncentrator
path
Nazwa centrum docelowego, która powinna zaczynać się od znaków alfabetycznych i zawierać tylko znaki alfanumeryczne lub podkreślenie.
Tak
string
grupa
path
Nazwa grupy docelowej, która długość powinna być większa niż 0 i mniejsza niż 1025.
Tak
string
aplikacja
zapytanie
Nazwa aplikacji docelowej, która powinna zaczynać się od znaków alfabetycznych i zawierać tylko znaki alfanumeryczne lub podkreślenie.
Nie.
string
Wykluczone
zapytanie
Wykluczone identyfikatory połączeń
Nie.
[ ciąg ]
api-version
zapytanie
Wersja interfejsów API REST.
Tak
string
wiadomość
treść
Komunikat ładunku.
Tak
PayloadMessage
Odpowiedzi
/api/hubs/{hub}/groups/{group}/connections/{connectionId}
ODŁÓŻ
Podsumowanie
Dodaj połączenie z grupą docelową.
Dodawanie połączenia z grupą docelową
PUT /api/hubs/{hub}/groups/{group}/connections/{connectionId}
Parametry
Nazwisko
Znajduje się w
opis
Wymagania
Schemat
koncentrator
path
Nazwa centrum docelowego, która powinna zaczynać się od znaków alfabetycznych i zawierać tylko znaki alfanumeryczne lub podkreślenie.
Tak
string
grupa
path
Nazwa grupy docelowej, która długość powinna być większa niż 0 i mniejsza niż 1025.
Tak
string
connectionId
path
Identyfikator połączenia docelowego
Tak
string
aplikacja
zapytanie
Nazwa aplikacji docelowej, która powinna zaczynać się od znaków alfabetycznych i zawierać tylko znaki alfanumeryczne lub podkreślenie.
Nie.
string
api-version
zapytanie
Wersja interfejsów API REST.
Tak
string
Odpowiedzi
DELETE
Podsumowanie
Usuń połączenie z grupy docelowej.
Usuwanie połączenia z grupy docelowej
DELETE /api/hubs/{hub}/groups/{group}/connections/{connectionId}
Parametry
Nazwisko
Znajduje się w
opis
Wymagania
Schemat
koncentrator
path
Nazwa centrum docelowego, która powinna zaczynać się od znaków alfabetycznych i zawierać tylko znaki alfanumeryczne lub podkreślenie.
Tak
string
grupa
path
Nazwa grupy docelowej, która długość powinna być większa niż 0 i mniejsza niż 1025.
Tak
string
connectionId
path
Identyfikator połączenia docelowego
Tak
string
aplikacja
zapytanie
Nazwa aplikacji docelowej, która powinna zaczynać się od znaków alfabetycznych i zawierać tylko znaki alfanumeryczne lub podkreślenie.
Nie.
string
api-version
zapytanie
Wersja interfejsów API REST.
Tak
string
Odpowiedzi
/api/hubs/{hub}/connections/{connectionId}/groups
DELETE
Podsumowanie
Usuwanie połączenia ze wszystkich grup
Usuwanie połączenia ze wszystkich grup
DELETE /api/hubs/{hub}/connections/{connectionId}/groups
Parametry
Nazwisko
Znajduje się w
opis
Wymagania
Schemat
koncentrator
path
Nazwa centrum docelowego, która powinna zaczynać się od znaków alfabetycznych i zawierać tylko znaki alfanumeryczne lub podkreślenie.
Tak
string
connectionId
path
Identyfikator połączenia docelowego
Tak
string
aplikacja
zapytanie
Nazwa aplikacji docelowej, która powinna zaczynać się od znaków alfabetycznych i zawierać tylko znaki alfanumeryczne lub podkreślenie.
Nie.
string
api-version
zapytanie
Wersja interfejsów API REST.
Tak
string
Odpowiedzi
/api/hubs/{hub}/users/{user}
HEAD
Podsumowanie
Sprawdź, czy istnieją połączenia klienta połączone dla danego użytkownika
Sprawdź, czy istnieją połączenia klienta połączone dla danego użytkownika
HEAD /api/hubs/{hub}/users/{user}
Parametry
Nazwisko
Znajduje się w
opis
Wymagania
Schemat
koncentrator
path
Nazwa centrum docelowego, która powinna zaczynać się od znaków alfabetycznych i zawierać tylko znaki alfanumeryczne lub podkreślenie.
Tak
string
Użytkownik
path
Identyfikator użytkownika.
Tak
string
aplikacja
zapytanie
Nazwa aplikacji docelowej, która powinna zaczynać się od znaków alfabetycznych i zawierać tylko znaki alfanumeryczne lub podkreślenie.
Nie.
string
api-version
zapytanie
Wersja interfejsów API REST.
Tak
string
Odpowiedzi
/api/hubs/{hub}/users/{user}/:closeConnections
POST
Podsumowanie
Zamknij połączenia dla określonego użytkownika.
Zamykanie połączeń dla określonego użytkownika
POST /api/hubs/{hub}/users/{user}/:closeConnections
Parametry
Nazwisko
Znajduje się w
opis
Wymagania
Schemat
koncentrator
path
Nazwa centrum docelowego, która powinna zaczynać się od znaków alfabetycznych i zawierać tylko znaki alfanumeryczne lub podkreślenie.
Tak
string
Użytkownik
path
Identyfikator użytkownika.
Tak
string
aplikacja
zapytanie
Nazwa aplikacji docelowej, która powinna zaczynać się od znaków alfabetycznych i zawierać tylko znaki alfanumeryczne lub podkreślenie.
Nie.
string
Wykluczone
zapytanie
Wyklucz te identyfikatory connectionId podczas zamykania połączeń w centrum.
Nie.
[ ciąg ]
reason
zapytanie
Przyczyna zamknięcia połączeń klienta.
Nie.
string
api-version
zapytanie
Wersja interfejsów API REST.
Tak
string
Odpowiedzi
Kod
opis
Schemat
204
Powodzenie
domyślna
Odpowiedź błędna
ErrorDetail
/api/hubs/{hub}/users/{user}/:send
POST
Podsumowanie
Emisja komunikatu do wszystkich klientów należy do użytkownika docelowego.
Emisja komunikatu do wszystkich klientów należy do użytkownika docelowego
POST /api/hubs/{hub}/users/{user}/:send
Parametry
Nazwisko
Znajduje się w
opis
Wymagania
Schemat
koncentrator
path
Nazwa centrum docelowego, która powinna zaczynać się od znaków alfabetycznych i zawierać tylko znaki alfanumeryczne lub podkreślenie.
Tak
string
Użytkownik
path
Identyfikator użytkownika.
Tak
string
aplikacja
zapytanie
Nazwa aplikacji docelowej, która powinna zaczynać się od znaków alfabetycznych i zawierać tylko znaki alfanumeryczne lub podkreślenie.
Nie.
string
api-version
zapytanie
Wersja interfejsów API REST.
Tak
string
wiadomość
treść
Komunikat ładunku.
Tak
PayloadMessage
Odpowiedzi
/api/hubs/{hub}/users/{user}/groups/{group}
HEAD
Podsumowanie
Sprawdź, czy użytkownik istnieje w grupie docelowej.
Sprawdzanie, czy użytkownik istnieje w grupie docelowej
HEAD /api/hubs/{hub}/users/{user}/groups/{group}
Parametry
Nazwisko
Znajduje się w
opis
Wymagania
Schemat
koncentrator
path
Nazwa centrum docelowego, która powinna zaczynać się od znaków alfabetycznych i zawierać tylko znaki alfanumeryczne lub podkreślenie.
Tak
string
grupa
path
Nazwa grupy docelowej, która długość powinna być większa niż 0 i mniejsza niż 1025.
Tak
string
Użytkownik
path
Identyfikator użytkownika docelowego
Tak
string
aplikacja
zapytanie
Nazwa aplikacji docelowej, która powinna zaczynać się od znaków alfabetycznych i zawierać tylko znaki alfanumeryczne lub podkreślenie.
Nie.
string
api-version
zapytanie
Wersja interfejsów API REST.
Tak
string
Odpowiedzi
ODŁÓŻ
Podsumowanie
Dodaj użytkownika do grupy docelowej.
Dodawanie użytkownika do grupy docelowej
PUT /api/hubs/{hub}/users/{user}/groups/{group}
Parametry
Nazwisko
Znajduje się w
opis
Wymagania
Schemat
koncentrator
path
Nazwa centrum docelowego, która powinna zaczynać się od znaków alfabetycznych i zawierać tylko znaki alfanumeryczne lub podkreślenie.
Tak
string
grupa
path
Nazwa grupy docelowej, która długość powinna być większa niż 0 i mniejsza niż 1025.
Tak
string
Użytkownik
path
Identyfikator użytkownika docelowego
Tak
string
aplikacja
zapytanie
Nazwa aplikacji docelowej, która powinna zaczynać się od znaków alfabetycznych i zawierać tylko znaki alfanumeryczne lub podkreślenie.
Nie.
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. Jeśli użytkownik zostanie dodany do niektórych grup bez ograniczenia czasu wygaśnięcia, tylko najnowsze zaktualizowane 100 grup zostanie zarezerwowanych wśród wszystkich grup, do których użytkownik dołączył bez czasu wygaśnięcia. Jeśli czas wygaśnięcia = 0, do grupy docelowej zostaną dodane tylko bieżące połączone połączenia użytkownika docelowego.
Nie.
integer
api-version
zapytanie
Wersja interfejsów API REST.
Tak
string
Odpowiedzi
DELETE
Podsumowanie
Usuń użytkownika z grupy docelowej.
Usuwanie użytkownika z grupy docelowej
DELETE /api/hubs/{hub}/users/{user}/groups/{group}
Parametry
Nazwisko
Znajduje się w
opis
Wymagania
Schemat
koncentrator
path
Nazwa centrum docelowego, która powinna zaczynać się od znaków alfabetycznych i zawierać tylko znaki alfanumeryczne lub podkreślenie.
Tak
string
grupa
path
Nazwa grupy docelowej, która długość powinna być większa niż 0 i mniejsza niż 1025.
Tak
string
Użytkownik
path
Identyfikator użytkownika docelowego
Tak
string
aplikacja
zapytanie
Nazwa aplikacji docelowej, która powinna zaczynać się od znaków alfabetycznych i zawierać tylko znaki alfanumeryczne lub podkreślenie.
Nie.
string
api-version
zapytanie
Wersja interfejsów API REST.
Tak
string
Odpowiedzi
Kod
opis
Schemat
204
Powodzenie
domyślna
Odpowiedź błędna
ErrorDetail
/api/hubs/{hub}/users/{user}/groups
DELETE
Podsumowanie
Usuń użytkownika ze wszystkich grup.
Usuwanie użytkownika ze wszystkich grup
DELETE /api/hubs/{hub}/users/{user}/groups
Parametry
Nazwisko
Znajduje się w
opis
Wymagania
Schemat
koncentrator
path
Nazwa centrum docelowego, która powinna 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
aplikacja
zapytanie
Nazwa aplikacji docelowej, która powinna zaczynać się od znaków alfabetycznych i zawierać tylko znaki alfanumeryczne lub podkreślenie.
Nie.
string
api-version
zapytanie
Wersja interfejsów API REST.
Tak
string
Odpowiedzi
Kod
opis
Schemat
204
Powodzenie
domyślna
Odpowiedź błędna
ErrorDetail
Modele
ErrorDetail
Obiekt błędu.
Nazwisko
Pisz
Opis
Wymagania
code
string
Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
Nie.
wiadomość
string
Czytelna dla człowieka reprezentacja błędu.
Nie.
target
string
Obiekt docelowy błędu.
Nie.
szczegóły
[ ErrorDetail ]
Tablica szczegółów dotyczących określonych błędów, które doprowadziły do tego zgłoszonego błędu.
Nie.
wewnętrzny
InnerError Nie.
InnerError
Nazwisko
Pisz
Opis
Wymagania
code
string
Bardziej szczegółowy kod błędu niż został dostarczony przez błąd zawierający.
Nie.
wewnętrzny
InnerError Nie.
PayloadMessage
Nazwisko
Pisz
Opis
Wymagania
target
string
Tak
Argumenty
[ ]
Nie.
ServiceResponse
Nazwisko
Pisz
Opis
Wymagania
code
string
Nie
poziom
string
Wyliczenie: "Info", , "Warning""Error"Nie.
zakres
string
Wyliczenie: "Unknown", , "Request""Connection", , "User""Group"Nie.
errorKind
string
Wyliczenie: , , "NotExisted""NotInGroup","Unknown""Invalid"Nie.
wiadomość
string
Nie
jsonObject
Nie.
isSuccess
boolean
Nie.