Questo articolo contiene le API REST della versione 1 per Servizio Azure SignalR piano dati.
API disponibili
Trasmettere un messaggio a tutti i client connessi all'hub di destinazione.
POST /api/v1/hubs/{hub}
Parametri
| Nome |
Posizione |
Descrizione |
Richiesto |
Schema |
| hub |
path |
Nome dell'hub di destinazione, che deve iniziare con caratteri alfabetici e contenere solo caratteri alfanumerici o caratteri di sottolineatura. |
Sì |
stringa |
| Escluso |
query |
ID connessione esclusi |
No |
[ string ] |
Risposte
| Codice |
Descrizione |
| 202 |
Riuscita |
| 400 |
Richiesta non valida |
Trasmettere un messaggio a tutti i client appartengono all'utente di destinazione.
POST /api/v1/hubs/{hub}/users/{id}
Parametri
| Nome |
Posizione |
Descrizione |
Richiesto |
Schema |
| hub |
path |
Nome dell'hub di destinazione, che deve iniziare con caratteri alfabetici e contenere solo caratteri alfanumerici o caratteri di sottolineatura. |
Sì |
stringa |
| ID |
path |
ID utente. |
Sì |
stringa |
Risposte
| Codice |
Descrizione |
| 202 |
Riuscita |
| 400 |
Richiesta non valida |
Inviare un messaggio alla connessione specifica.
POST /api/v1/hubs/{hub}/connections/{connectionId}
Parametri
| Nome |
Posizione |
Descrizione |
Richiesto |
Schema |
| hub |
path |
Nome dell'hub di destinazione, che deve iniziare con caratteri alfabetici e contenere solo caratteri alfanumerici o caratteri di sottolineatura. |
Sì |
stringa |
| connectionId |
path |
ID connessione. |
Sì |
stringa |
Risposte
| Codice |
Descrizione |
| 202 |
Riuscita |
| 400 |
Richiesta non valida |
Controllare se la connessione con l'id connessione specificato esiste
GET /api/v1/hubs/{hub}/connections/{connectionId}
Parametri
| Nome |
Posizione |
Descrizione |
Richiesto |
Schema |
| hub |
path |
|
Sì |
stringa |
| connectionId |
path |
|
Sì |
stringa |
Risposte
| Codice |
Descrizione |
| 200 |
Riuscita |
| 400 |
Richiesta non valida |
| 404 |
Non trovato |
Chiudere la connessione client
DELETE /api/v1/hubs/{hub}/connections/{connectionId}
Parametri
| Nome |
Posizione |
Descrizione |
Richiesto |
Schema |
| hub |
path |
|
Sì |
stringa |
| connectionId |
path |
|
Sì |
stringa |
| reason |
query |
|
No |
stringa |
Risposte
| Codice |
Descrizione |
| 202 |
Riuscita |
| 400 |
Richiesta non valida |
Trasmettere un messaggio a tutti i client all'interno del gruppo di destinazione.
POST /api/v1/hubs/{hub}/groups/{group}
Parametri
| Nome |
Posizione |
Descrizione |
Richiesto |
Schema |
| hub |
path |
Nome dell'hub di destinazione, che deve iniziare con caratteri alfabetici e contenere solo caratteri alfanumerici o caratteri di sottolineatura. |
Sì |
stringa |
| gruppo |
path |
Nome del gruppo di destinazione, la cui lunghezza deve essere maggiore di 0 e minore di 1025. |
Sì |
stringa |
| Escluso |
query |
ID connessione esclusi |
No |
[ string ] |
Risposte
| Codice |
Descrizione |
| 202 |
Riuscita |
| 400 |
Richiesta non valida |
Controllare se sono presenti connessioni client all'interno del gruppo specificato
GET /api/v1/hubs/{hub}/groups/{group}
Parametri
| Nome |
Posizione |
Descrizione |
Richiesto |
Schema |
| hub |
path |
|
Sì |
stringa |
| gruppo |
path |
|
Sì |
stringa |
Risposte
| Codice |
Descrizione |
| 200 |
Riuscita |
| 400 |
Richiesta non valida |
| 404 |
Non trovato |
Controllare se sono presenti connessioni client connesse per l'utente specificato
GET /api/v1/hubs/{hub}/users/{user}
Parametri
| Nome |
Posizione |
Descrizione |
Richiesto |
Schema |
| hub |
path |
|
Sì |
stringa |
| utente |
path |
|
Sì |
stringa |
Risposte
| Codice |
Descrizione |
| 200 |
Riuscita |
| 400 |
Richiesta non valida |
| 404 |
Non trovato |
Aggiungere una connessione al gruppo di destinazione.
PUT /api/v1/hubs/{hub}/groups/{group}/connections/{connectionId}
Parametri
| Nome |
Posizione |
Descrizione |
Richiesto |
Schema |
| hub |
path |
Nome dell'hub di destinazione, che deve iniziare con caratteri alfabetici e contenere solo caratteri alfanumerici o caratteri di sottolineatura. |
Sì |
stringa |
| gruppo |
path |
Nome del gruppo di destinazione, la cui lunghezza deve essere maggiore di 0 e minore di 1025. |
Sì |
stringa |
| connectionId |
path |
ID connessione di destinazione |
Sì |
stringa |
Risposte
| Codice |
Descrizione |
| 200 |
Riuscita |
| 400 |
Richiesta non valida |
| 404 |
Non trovato |
Rimuovere una connessione dal gruppo di destinazione.
DELETE /api/v1/hubs/{hub}/groups/{group}/connections/{connectionId}
Parametri
| Nome |
Posizione |
Descrizione |
Richiesto |
Schema |
| hub |
path |
Nome dell'hub di destinazione, che deve iniziare con caratteri alfabetici e contenere solo caratteri alfanumerici o caratteri di sottolineatura. |
Sì |
stringa |
| gruppo |
path |
Nome del gruppo di destinazione, la cui lunghezza deve essere maggiore di 0 e minore di 1025. |
Sì |
stringa |
| connectionId |
path |
ID connessione di destinazione |
Sì |
stringa |
Risposte
| Codice |
Descrizione |
| 200 |
Riuscita |
| 400 |
Richiesta non valida |
| 404 |
Non trovato |
Controllare se un utente esiste nel gruppo di destinazione.
GET /api/v1/hubs/{hub}/groups/{group}/users/{user}
Parametri
| Nome |
Posizione |
Descrizione |
Richiesto |
Schema |
| hub |
path |
Nome dell'hub di destinazione, che deve iniziare con caratteri alfabetici e contenere solo caratteri alfanumerici o caratteri di sottolineatura. |
Sì |
stringa |
| gruppo |
path |
Nome del gruppo di destinazione, la cui lunghezza deve essere maggiore di 0 e minore di 1025. |
Sì |
stringa |
| utente |
path |
ID utente di destinazione |
Sì |
stringa |
Risposte
| Codice |
Descrizione |
| 200 |
Riuscita |
| 400 |
Richiesta non valida |
| 404 |
Non trovato |
Aggiungere un utente al gruppo di destinazione.
PUT /api/v1/hubs/{hub}/groups/{group}/users/{user}
Parametri
| Nome |
Posizione |
Descrizione |
Richiesto |
Schema |
| hub |
path |
Nome dell'hub di destinazione, che deve iniziare con caratteri alfabetici e contenere solo caratteri alfanumerici o caratteri di sottolineatura. |
Sì |
stringa |
| gruppo |
path |
Nome del gruppo di destinazione, la cui lunghezza deve essere maggiore di 0 e minore di 1025. |
Sì |
stringa |
| utente |
path |
ID utente di destinazione |
Sì |
stringa |
| ttl |
query |
Specifica i secondi in cui l'utente esiste nel gruppo. Se non impostato, l'utente risiede nel gruppo per un massimo di 1 anno. Si noti che quando ttl non è impostato, il servizio mantiene 100 relazioni tra gruppi di utenti per utente e una relazione di gruppo di utenti precedente vengono sovrascritte da quelle appena aggiunte. |
No |
integer |
Risposte
| Codice |
Descrizione |
| 202 |
Riuscita |
| 400 |
Richiesta non valida |
Rimuovere un utente dal gruppo di destinazione.
DELETE /api/v1/hubs/{hub}/groups/{group}/users/{user}
Parametri
| Nome |
Posizione |
Descrizione |
Richiesto |
Schema |
| hub |
path |
Nome dell'hub di destinazione, che deve iniziare con caratteri alfabetici e contenere solo caratteri alfanumerici o caratteri di sottolineatura. |
Sì |
stringa |
| gruppo |
path |
Nome del gruppo di destinazione, la cui lunghezza deve essere maggiore di 0 e minore di 1025. |
Sì |
stringa |
| utente |
path |
ID utente di destinazione |
Sì |
stringa |
Risposte
| Codice |
Descrizione |
| 202 |
Riuscita |
| 400 |
Richiesta non valida |
Rimuovere un utente da tutti i gruppi.
DELETE /api/v1/hubs/{hub}/users/{user}/groups
Parametri
| Nome |
Posizione |
Descrizione |
Richiesto |
Schema |
| hub |
path |
Nome dell'hub di destinazione, che deve iniziare con caratteri alfabetici e contenere solo caratteri alfanumerici o caratteri di sottolineatura. |
Sì |
stringa |
| utente |
path |
ID utente di destinazione |
Sì |
stringa |
Risposte
| Codice |
Descrizione |
| 200 |
L'utente viene eliminato |
| 202 |
La richiesta di eliminazione viene accettata e il servizio gestisce la richiesta in background |
| 400 |
Richiesta non valida |
Modelli
PayloadMessage
| Nome |
Digita |
Descrizione |
Richiesto |
| Destinazione |
string |
|
No |
| Argomenti |
[ object ] |
|
No |