Rozhraní REST API služby Azure SignalR
Článek 07/03/2024
1 přispěvatel
Váš názor
V tomto článku
Verze: 2022-06-01
Dostupná rozhraní API
/api/health
HEAD
Shrnutí
Získejte stav služby.
Získání stavu služby
HEAD /api/health
Parametry
Název
Nachází se v
Popis
Povinní účastníci
Schéma
verze-api
query
Verze rozhraní REST API.
Ano
string
Odpovědi
Kód
Popis
200
Služba je v pořádku.
default
Chybná odpověď
/api/hubs/{hub}/:closeConnections
POST
Shrnutí
Zavřete všechna připojení v centru.
Zavření všech připojení v centru
POST /api/hubs/{hub}/:closeConnections
Parametry
Název
Nachází se v
Popis
Povinní účastníci
Schéma
rozbočovač
path
Název cílového centra, který by měl začínat abecedním znakem a obsahovat pouze alfanumerické znaky nebo podtržítko.
Ano
string
aplikace
query
Název cílové aplikace, který by měl začínat abecedním znakem a obsahovat pouze alfanumerické znaky nebo podtržítko.
No
string
vyloučený
query
Při zavírání připojení v centru tyto ID připojení vyloučíte.
No
[ řetězec ]
reason
query
Důvod zavření připojení klientů.
No
string
verze-api
query
Verze rozhraní REST API.
Ano
string
Odpovědi
Kód
Popis
Schéma
204
Success
default
Chybná odpověď
ErrorDetail
/api/hubs/{hub}/:send
POST
Shrnutí
Vysílejte zprávu všem klientům připojeným k cílovému centru.
Vysílání zprávy všem klientům připojeným k cílovému centru
POST /api/hubs/{hub}/:send
Parametry
Název
Nachází se v
Popis
Povinní účastníci
Schéma
rozbočovač
path
Název cílového centra, který by měl začínat abecedním znakem a obsahovat pouze alfanumerické znaky nebo podtržítko.
Ano
string
aplikace
query
Název cílové aplikace, který by měl začínat abecedním znakem a obsahovat pouze alfanumerické znaky nebo podtržítko.
No
string
vyloučený
query
Vyloučené ID připojení
No
[ řetězec ]
verze-api
query
Verze rozhraní REST API.
Ano
string
zpráva
text
Zpráva datové části.
Ano
PayloadMessage
Odpovědi
/api/hubs/{hub}/connections/{connectionId}
HEAD
Shrnutí
Zkontrolujte, jestli připojení s daným ID připojení existuje.
Zkontrolujte, jestli připojení s daným ID připojení existuje.
HEAD /api/hubs/{hub}/connections/{connectionId}
Parametry
Název
Nachází se v
Popis
Povinní účastníci
Schéma
rozbočovač
path
Název cílového centra, který by měl začínat abecedním znakem a obsahovat pouze alfanumerické znaky nebo podtržítko.
Ano
string
connectionId
path
ID připojení.
Ano
string
aplikace
query
Název cílové aplikace, který by měl začínat abecedním znakem a obsahovat pouze alfanumerické znaky nebo podtržítko.
No
string
verze-api
query
Verze rozhraní REST API.
Ano
string
Odpovědi
DELETE
Shrnutí
Zavření připojení klienta
Zavření připojení klienta
DELETE /api/hubs/{hub}/connections/{connectionId}
Parametry
Název
Nachází se v
Popis
Povinní účastníci
Schéma
rozbočovač
path
Název cílového centra, který by měl začínat abecedním znakem a obsahovat pouze alfanumerické znaky nebo podtržítko.
Ano
string
connectionId
path
ID připojení.
Ano
string
aplikace
query
Název cílové aplikace, který by měl začínat abecedním znakem a obsahovat pouze alfanumerické znaky nebo podtržítko.
No
string
reason
query
Důvod ukončení připojení.
No
string
verze-api
query
Verze rozhraní REST API.
Ano
string
Odpovědi
/api/hubs/{hub}/connections/{connectionId}/:send
POST
Shrnutí
Odešle zprávu konkrétnímu připojení.
Odeslání zprávy ke konkrétnímu připojení
POST /api/hubs/{hub}/connections/{connectionId}/:send
Parametry
Název
Nachází se v
Popis
Povinní účastníci
Schéma
rozbočovač
path
Název cílového centra, který by měl začínat abecedním znakem a obsahovat pouze alfanumerické znaky nebo podtržítko.
Ano
string
connectionId
path
ID připojení.
Ano
string
aplikace
query
Název cílové aplikace, který by měl začínat abecedním znakem a obsahovat pouze alfanumerické znaky nebo podtržítko.
No
string
verze-api
query
Verze rozhraní REST API.
Ano
string
zpráva
text
Zpráva datové části.
Ano
PayloadMessage
Odpovědi
/api/hubs/{hub}/groups/{group}
HEAD
Shrnutí
Zkontrolujte, jestli v dané skupině nejsou nějaká klientská připojení.
Zkontrolujte, jestli v dané skupině nejsou nějaká klientská připojení.
HEAD /api/hubs/{hub}/groups/{group}
Parametry
Název
Nachází se v
Popis
Povinní účastníci
Schéma
rozbočovač
path
Název cílového centra, který by měl začínat abecedním znakem a obsahovat pouze alfanumerické znaky nebo podtržítko.
Ano
string
skupina
path
Název cílové skupiny, která by měla být větší než 0 a menší než 1025.
Ano
string
aplikace
query
Název cílové aplikace, který by měl začínat abecedním znakem a obsahovat pouze alfanumerické znaky nebo podtržítko.
No
string
verze-api
query
Verze rozhraní REST API.
Ano
string
Odpovědi
/api/hubs/{hub}/groups/{group}/:closeConnections
POST
Shrnutí
Ukončete připojení v konkrétní skupině.
Zavření připojení v konkrétní skupině
POST /api/hubs/{hub}/groups/{group}/:closeConnections
Parametry
Název
Nachází se v
Popis
Povinní účastníci
Schéma
rozbočovač
path
Název cílového centra, který by měl začínat abecedním znakem a obsahovat pouze alfanumerické znaky nebo podtržítko.
Ano
string
skupina
path
Název cílové skupiny, která by měla být větší než 0 a menší než 1025.
Ano
string
aplikace
query
Název cílové aplikace, který by měl začínat abecedním znakem a obsahovat pouze alfanumerické znaky nebo podtržítko.
No
string
vyloučený
query
Při zavírání připojení v centru tyto ID připojení vyloučíte.
No
[ řetězec ]
reason
query
Důvod zavření připojení klientů.
No
string
verze-api
query
Verze rozhraní REST API.
Ano
string
Odpovědi
Kód
Popis
Schéma
204
Success
default
Chybná odpověď
ErrorDetail
/api/hubs/{hub}/groups/{group}/:send
POST
Shrnutí
Vysílejte zprávu všem klientům v cílové skupině.
Vysílání zprávy všem klientům v cílové skupině
POST /api/hubs/{hub}/groups/{group}/:send
Parametry
Název
Nachází se v
Popis
Povinní účastníci
Schéma
rozbočovač
path
Název cílového centra, který by měl začínat abecedním znakem a obsahovat pouze alfanumerické znaky nebo podtržítko.
Ano
string
skupina
path
Název cílové skupiny, která by měla být větší než 0 a menší než 1025.
Ano
string
aplikace
query
Název cílové aplikace, který by měl začínat abecedním znakem a obsahovat pouze alfanumerické znaky nebo podtržítko.
No
string
vyloučený
query
Vyloučené ID připojení
No
[ řetězec ]
verze-api
query
Verze rozhraní REST API.
Ano
string
zpráva
text
Zpráva datové části.
Ano
PayloadMessage
Odpovědi
/api/hubs/{hub}/groups/{group}/connections/{connectionId}
PUT
Shrnutí
Přidejte připojení k cílové skupině.
Přidání připojení k cílové skupině
PUT /api/hubs/{hub}/groups/{group}/connections/{connectionId}
Parametry
Název
Nachází se v
Popis
Povinní účastníci
Schéma
rozbočovač
path
Název cílového centra, který by měl začínat abecedním znakem a obsahovat pouze alfanumerické znaky nebo podtržítko.
Ano
string
skupina
path
Název cílové skupiny, která by měla být větší než 0 a menší než 1025.
Ano
string
connectionId
path
ID cílového připojení
Ano
string
aplikace
query
Název cílové aplikace, který by měl začínat abecedním znakem a obsahovat pouze alfanumerické znaky nebo podtržítko.
No
string
verze-api
query
Verze rozhraní REST API.
Ano
string
Odpovědi
DELETE
Shrnutí
Odeberte připojení z cílové skupiny.
Odebrání připojení z cílové skupiny
DELETE /api/hubs/{hub}/groups/{group}/connections/{connectionId}
Parametry
Název
Nachází se v
Popis
Povinní účastníci
Schéma
rozbočovač
path
Název cílového centra, který by měl začínat abecedním znakem a obsahovat pouze alfanumerické znaky nebo podtržítko.
Ano
string
skupina
path
Název cílové skupiny, která by měla být větší než 0 a menší než 1025.
Ano
string
connectionId
path
ID cílového připojení
Ano
string
aplikace
query
Název cílové aplikace, který by měl začínat abecedním znakem a obsahovat pouze alfanumerické znaky nebo podtržítko.
No
string
verze-api
query
Verze rozhraní REST API.
Ano
string
Odpovědi
/api/hubs/{hub}/connections/{connectionId}/groups
DELETE
Shrnutí
Odebrání připojení ze všech skupin
Odebrání připojení ze všech skupin
DELETE /api/hubs/{hub}/connections/{connectionId}/groups
Parametry
Název
Nachází se v
Popis
Povinní účastníci
Schéma
rozbočovač
path
Název cílového centra, který by měl začínat abecedním znakem a obsahovat pouze alfanumerické znaky nebo podtržítko.
Ano
string
connectionId
path
ID cílového připojení
Ano
string
aplikace
query
Název cílové aplikace, který by měl začínat abecedním znakem a obsahovat pouze alfanumerické znaky nebo podtržítko.
No
string
verze-api
query
Verze rozhraní REST API.
Ano
string
Odpovědi
/api/hubs/{hub}/users/{user}
HEAD
Shrnutí
Zkontrolujte, jestli pro daného uživatele nejsou připojená nějaká připojení klientů.
Zkontrolujte, jestli pro daného uživatele nejsou připojená nějaká připojení klientů.
HEAD /api/hubs/{hub}/users/{user}
Parametry
Název
Nachází se v
Popis
Povinní účastníci
Schéma
rozbočovač
path
Název cílového centra, který by měl začínat abecedním znakem a obsahovat pouze alfanumerické znaky nebo podtržítko.
Ano
string
user
path
ID uživatele.
Ano
string
aplikace
query
Název cílové aplikace, který by měl začínat abecedním znakem a obsahovat pouze alfanumerické znaky nebo podtržítko.
No
string
verze-api
query
Verze rozhraní REST API.
Ano
string
Odpovědi
/api/hubs/{hub}/users/{user}/:closeConnections
POST
Shrnutí
Zavřete připojení pro konkrétního uživatele.
Zavření připojení pro konkrétního uživatele
POST /api/hubs/{hub}/users/{user}/:closeConnections
Parametry
Název
Nachází se v
Popis
Povinní účastníci
Schéma
rozbočovač
path
Název cílového centra, který by měl začínat abecedním znakem a obsahovat pouze alfanumerické znaky nebo podtržítko.
Ano
string
user
path
ID uživatele.
Ano
string
aplikace
query
Název cílové aplikace, který by měl začínat abecedním znakem a obsahovat pouze alfanumerické znaky nebo podtržítko.
No
string
vyloučený
query
Při zavírání připojení v centru tyto ID připojení vyloučíte.
No
[ řetězec ]
reason
query
Důvod zavření připojení klientů.
No
string
verze-api
query
Verze rozhraní REST API.
Ano
string
Odpovědi
Kód
Popis
Schéma
204
Success
default
Chybná odpověď
ErrorDetail
/api/hubs/{hub}/users/{user}/:send
POST
Shrnutí
Vysílání zprávy všem klientům patří cílovému uživateli.
Vysílání zprávy všem klientům patří cílovému uživateli
POST /api/hubs/{hub}/users/{user}/:send
Parametry
Název
Nachází se v
Popis
Povinní účastníci
Schéma
rozbočovač
path
Název cílového centra, který by měl začínat abecedním znakem a obsahovat pouze alfanumerické znaky nebo podtržítko.
Ano
string
user
path
ID uživatele.
Ano
string
aplikace
query
Název cílové aplikace, který by měl začínat abecedním znakem a obsahovat pouze alfanumerické znaky nebo podtržítko.
No
string
verze-api
query
Verze rozhraní REST API.
Ano
string
zpráva
text
Zpráva datové části.
Ano
PayloadMessage
Odpovědi
/api/hubs/{hub}/users/{user}/groups/{group}
HEAD
Shrnutí
Zkontrolujte, jestli v cílové skupině existuje uživatel.
Kontrola, jestli uživatel v cílové skupině existuje
HEAD /api/hubs/{hub}/users/{user}/groups/{group}
Parametry
Název
Nachází se v
Popis
Povinní účastníci
Schéma
rozbočovač
path
Název cílového centra, který by měl začínat abecedním znakem a obsahovat pouze alfanumerické znaky nebo podtržítko.
Ano
string
skupina
path
Název cílové skupiny, která by měla být větší než 0 a menší než 1025.
Ano
string
user
path
ID cílového uživatele
Ano
string
aplikace
query
Název cílové aplikace, který by měl začínat abecedním znakem a obsahovat pouze alfanumerické znaky nebo podtržítko.
No
string
verze-api
query
Verze rozhraní REST API.
Ano
string
Odpovědi
PUT
Shrnutí
Přidejte uživatele do cílové skupiny.
Přidání uživatele do cílové skupiny
PUT /api/hubs/{hub}/users/{user}/groups/{group}
Parametry
Název
Nachází se v
Popis
Povinní účastníci
Schéma
rozbočovač
path
Název cílového centra, který by měl začínat abecedním znakem a obsahovat pouze alfanumerické znaky nebo podtržítko.
Ano
string
skupina
path
Název cílové skupiny, která by měla být větší než 0 a menší než 1025.
Ano
string
user
path
ID cílového uživatele
Ano
string
aplikace
query
Název cílové aplikace, který by měl začínat abecedním znakem a obsahovat pouze alfanumerické znaky nebo podtržítko.
No
string
TTL
query
Určuje sekundy, po které uživatel ve skupině existuje. Pokud není nastavený, uživatel žije ve skupině maximálně po dobu 1 roku. Pokud se uživatel přidá do některých skupin bez omezení ttl, bude rezervováno pouze nejnovějších 100 skupin, které uživatel připojil bez hodnoty TTL. Pokud ttl = 0, přidá se do cílové skupiny pouze aktuální připojená připojení cílového uživatele.
No
integer
verze-api
query
Verze rozhraní REST API.
Ano
string
Odpovědi
DELETE
Shrnutí
Odeberte uživatele z cílové skupiny.
Odebrání uživatele z cílové skupiny
DELETE /api/hubs/{hub}/users/{user}/groups/{group}
Parametry
Název
Nachází se v
Popis
Povinní účastníci
Schéma
rozbočovač
path
Název cílového centra, který by měl začínat abecedním znakem a obsahovat pouze alfanumerické znaky nebo podtržítko.
Ano
string
skupina
path
Název cílové skupiny, která by měla být větší než 0 a menší než 1025.
Ano
string
user
path
ID cílového uživatele
Ano
string
aplikace
query
Název cílové aplikace, který by měl začínat abecedním znakem a obsahovat pouze alfanumerické znaky nebo podtržítko.
No
string
verze-api
query
Verze rozhraní REST API.
Ano
string
Odpovědi
Kód
Popis
Schéma
204
Success
default
Chybná odpověď
ErrorDetail
/api/hubs/{hub}/users/{user}/groups
DELETE
Shrnutí
Odeberte uživatele ze všech skupin.
Odebrání uživatele ze všech skupin
DELETE /api/hubs/{hub}/users/{user}/groups
Parametry
Název
Nachází se v
Popis
Povinní účastníci
Schéma
rozbočovač
path
Název cílového centra, který by měl začínat abecedním znakem a obsahovat pouze alfanumerické znaky nebo podtržítko.
Ano
string
user
path
ID cílového uživatele
Ano
string
aplikace
query
Název cílové aplikace, který by měl začínat abecedním znakem a obsahovat pouze alfanumerické znaky nebo podtržítko.
No
string
verze-api
query
Verze rozhraní REST API.
Ano
string
Odpovědi
Kód
Popis
Schéma
204
Success
default
Chybná odpověď
ErrorDetail
Modely
ErrorDetail
Objekt chyby.
Name
Typ
Popis
Povinní účastníci
code
string
Jedna ze serverově definovaných kódů chyb.
No
zpráva
string
Čitelné znázornění chyby člověkem.
No
target
string
Cíl chyby
No
Podrobnosti
[ ErrorDetail ]
Pole podrobností o konkrétních chybách, které vedly k této nahlášené chybě.
No
vnitřní
Vnitřní chyba No
Vnitřní chyba
Name
Typ
Popis
Povinní účastníci
code
string
Konkrétnější kód chyby, než poskytla chyba obsahující chybu.
No
vnitřní
Vnitřní chyba No
PayloadMessage
Name
Typ
Popis
Povinní účastníci
target
string
Ano
argumenty
[ ]
No
ServiceResponse
Name
Typ
Popis
Povinní účastníci
code
string
No
úroveň
string
Výčt: "Info", , "Warning""Error"No
rozsah
string
Výčt: "Unknown", "Request", "Connection", , "User""Group"No
errorKind
string
Výčt: "Unknown", "NotExisted", , "NotInGroup""Invalid"No
zpráva
string
No
jsonObject
No
isSuccess
boolean
Ne