Sdílet prostřednictvím

Rozhraní REST API roviny dat služby Azure SignalR – v1

  • Článek

Tento článek obsahuje rozhraní REST API verze 1 pro rovinu dat služby Azure SignalR.

Dostupná rozhraní API

API Cesta
Vysílejte zprávu všem klientům připojeným k cílovému centru. POST /api/v1/hubs/{hub}
Vysílání zprávy všem klientům patří cílovému uživateli. POST /api/v1/hubs/{hub}/users/{id}
Odešle zprávu konkrétnímu připojení. POST /api/v1/hubs/{hub}/connections/{connectionId}
Zkontrolujte, jestli připojení s daným ID připojení existuje. GET /api/v1/hubs/{hub}/connections/{connectionId}
Zavření připojení klienta DELETE /api/v1/hubs/{hub}/connections/{connectionId}
Vysílejte zprávu všem klientům v cílové skupině. POST /api/v1/hubs/{hub}/groups/{group}
Zkontrolujte, jestli v dané skupině nejsou nějaká klientská připojení. GET /api/v1/hubs/{hub}/groups/{group}
Zkontrolujte, jestli pro daného uživatele nejsou připojená nějaká připojení klientů. GET /api/v1/hubs/{hub}/users/{user}
Přidejte připojení k cílové skupině. PUT /api/v1/hubs/{hub}/groups/{group}/connections/{connectionId}
Odeberte připojení z cílové skupiny. DELETE /api/v1/hubs/{hub}/groups/{group}/connections/{connectionId}
Zkontrolujte, jestli v cílové skupině existuje uživatel. GET /api/v1/hubs/{hub}/groups/{group}/users/{user}
Přidejte uživatele do cílové skupiny. PUT /api/v1/hubs/{hub}/groups/{group}/users/{user}
Odeberte uživatele z cílové skupiny. DELETE /api/v1/hubs/{hub}/groups/{group}/users/{user}
Odeberte uživatele ze všech skupin. DELETE /api/v1/hubs/{hub}/users/{user}/groups

Vysílejte zprávu všem klientům připojeným k cílovému centru.

POST /api/v1/hubs/{hub}

Parametry
Název Nachází se v Popis Požaduje se Schéma
Rozbočovač path Název cílového centra, který musí začínat abecedním znakem a obsahovat pouze alfanumerické znaky nebo podtržítko. Ano řetězec
Vyloučeny query Vyloučené ID připojení No [ řetězec ]
Odpovědi
Kód Popis
202 Success
400 Nesprávná žádost

Vysílání zprávy všem klientům patří cílovému uživateli.

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

Parametry
Název Nachází se v Popis Požaduje se Schéma
Rozbočovač path Název cílového centra, který musí začínat abecedním znakem a obsahovat pouze alfanumerické znaky nebo podtržítko. Ano řetězec
ID path ID uživatele. Ano řetězec
Odpovědi
Kód Popis
202 Success
400 Nesprávná žádost

Odešle zprávu konkrétnímu připojení.

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

Parametry
Název Nachází se v Popis Požaduje se Schéma
Rozbočovač path Název cílového centra, který musí začínat abecedním znakem a obsahovat pouze alfanumerické znaky nebo podtržítko. Ano řetězec
connectionId path ID připojení. Ano řetězec
Odpovědi
Kód Popis
202 Success
400 Nesprávná žádost

Zkontrolujte, jestli připojení s daným ID připojení existuje.

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

Parametry
Název Nachází se v Popis Požaduje se Schéma
Rozbočovač path Ano řetězec
connectionId path Ano řetězec
Odpovědi
Kód Popis
200 Akce proběhla úspěšně
400 Nesprávná žádost
404 Nenalezeno

Zavření připojení klienta

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

Parametry
Název Nachází se v Popis Požaduje se Schéma
Rozbočovač path Ano řetězec
connectionId path Ano řetězec
reason query No řetězec
Odpovědi
Kód Popis
202 Success
400 Nesprávná žádost

Vysílejte zprávu všem klientům v cílové skupině.

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

Parametry
Název Nachází se v Popis Požaduje se Schéma
Rozbočovač path Název cílového centra, který musí začínat abecedním znakem a obsahovat pouze alfanumerické znaky nebo podtržítko. Ano řetězec
skupina path Název cílové skupiny, jehož délka musí být větší než 0 a menší než 1025. Ano řetězec
Vyloučeny query Vyloučené ID připojení No [ řetězec ]
Odpovědi
Kód Popis
202 Success
400 Nesprávná žádost

Zkontrolujte, jestli v dané skupině nejsou nějaká klientská připojení.

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

Parametry
Název Nachází se v Popis Požaduje se Schéma
Rozbočovač path Ano řetězec
skupina path Ano řetězec
Odpovědi
Kód Popis
200 Akce proběhla úspěšně
400 Nesprávná žádost
404 Nenalezeno

Zkontrolujte, jestli pro daného uživatele nejsou připojená nějaká připojení klientů.

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

Parametry
Název Nachází se v Popis Požaduje se Schéma
Rozbočovač path Ano řetězec
Uživatel path Ano řetězec
Odpovědi
Kód Popis
200 Akce proběhla úspěšně
400 Nesprávná žádost
404 Nenalezeno

Přidejte připojení k cílové skupině.

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

Parametry
Název Nachází se v Popis Požaduje se Schéma
Rozbočovač path Název cílového centra, který musí začínat abecedním znakem a obsahovat pouze alfanumerické znaky nebo podtržítko. Ano řetězec
skupina path Název cílové skupiny, jehož délka musí být větší než 0 a menší než 1025. Ano řetězec
connectionId path ID cílového připojení Ano řetězec
Odpovědi
Kód Popis
200 Akce proběhla úspěšně
400 Nesprávná žádost
404 Nenalezeno

Odeberte připojení z cílové skupiny.

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

Parametry
Název Nachází se v Popis Požaduje se Schéma
Rozbočovač path Název cílového centra, který musí začínat abecedním znakem a obsahovat pouze alfanumerické znaky nebo podtržítko. Ano řetězec
skupina path Název cílové skupiny, jehož délka musí být větší než 0 a menší než 1025. Ano řetězec
connectionId path ID cílového připojení Ano řetězec
Odpovědi
Kód Popis
200 Akce proběhla úspěšně
400 Nesprávná žádost
404 Nenalezeno

Zkontrolujte, jestli v cílové skupině existuje uživatel.

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

Parametry
Název Nachází se v Popis Požaduje se Schéma
Rozbočovač path Název cílového centra, který musí začínat abecedním znakem a obsahovat pouze alfanumerické znaky nebo podtržítko. Ano řetězec
skupina path Název cílové skupiny, jehož délka musí být větší než 0 a menší než 1025. Ano řetězec
Uživatel path ID cílového uživatele Ano řetězec
Odpovědi
Kód Popis
200 Akce proběhla úspěšně
400 Nesprávná žádost
404 Nenalezeno

Přidejte uživatele do cílové skupiny.

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

Parametry
Název Nachází se v Popis Požaduje se Schéma
Rozbočovač path Název cílového centra, který musí začínat abecedním znakem a obsahovat pouze alfanumerické znaky nebo podtržítko. Ano řetězec
skupina path Název cílové skupiny, jehož délka musí být větší než 0 a menší než 1025. Ano řetězec
Uživatel path ID cílového uživatele Ano řetězec
TTL query Určuje sekundy, po které uživatel ve skupině existuje. Pokud není nastavený, uživatel žije ve skupině maximálně 1 rok. Všimněte si, že pokud není nastavená hodnota ttl, služba zachovává 100 relací skupiny uživatelů na uživatele a starý vztah skupiny uživatelů se přepíšou nově přidanými relacemi. No integer
Odpovědi
Kód Popis
202 Success
400 Nesprávná žádost

Odeberte uživatele z cílové skupiny.

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

Parametry
Název Nachází se v Popis Požaduje se Schéma
Rozbočovač path Název cílového centra, který musí začínat abecedním znakem a obsahovat pouze alfanumerické znaky nebo podtržítko. Ano řetězec
skupina path Název cílové skupiny, jehož délka musí být větší než 0 a menší než 1025. Ano řetězec
Uživatel path ID cílového uživatele Ano řetězec
Odpovědi
Kód Popis
202 Success
400 Nesprávná žádost

Odeberte uživatele ze všech skupin.

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

Parametry
Název Nachází se v Popis Požaduje se Schéma
Rozbočovač path Název cílového centra, který musí začínat abecedním znakem a obsahovat pouze alfanumerické znaky nebo podtržítko. Ano řetězec
Uživatel path ID cílového uživatele Ano řetězec
Odpovědi
Kód Popis
200 Uživatel se odstraní.
202 Žádost o odstranění se přijme a služba zpracovává požadavek na pozadí.
400 Nesprávná žádost

Modely

PayloadMessage

Name Typ Popis Požaduje se
Cíl řetězec No
Argumenty [ objekt ] No