Condividi tramite

API REST Servizio Azure SignalR

  • Articolo

Versione: 2022-06-01

API disponibili

API Percorso
Ottenere lo stato di integrità del servizio. HEAD /api/health
Chiudere tutte le connessioni nell'hub. POST /api/hubs/{hub}/:closeConnections
Trasmettere un messaggio a tutti i client connessi all'hub di destinazione. POST /api/hubs/{hub}/:send
Controllare se la connessione con l'id connessione specificato esiste HEAD /api/hubs/{hub}/connections/{connectionId}
Chiudere la connessione client DELETE /api/hubs/{hub}/connections/{connectionId}
Inviare un messaggio alla connessione specifica. POST /api/hubs/{hub}/connections/{connectionId}/:send
Controllare se sono presenti connessioni client all'interno del gruppo specificato HEAD /api/hubs/{hub}/groups/{group}
Chiudere le connessioni nel gruppo specifico. POST /api/hubs/{hub}/groups/{group}/:closeConnections
Trasmettere un messaggio a tutti i client all'interno del gruppo di destinazione. POST /api/hubs/{hub}/groups/{group}/:send
Aggiungere una connessione al gruppo di destinazione. PUT /api/hubs/{hub}/groups/{group}/connections/{connectionId}
Rimuovere una connessione dal gruppo di destinazione. DELETE /api/hubs/{hub}/groups/{group}/connections/{connectionId}
Rimuovere una connessione da tutti i gruppi DELETE /api/hubs/{hub}/connections/{connectionId}/groups
Controllare se sono presenti connessioni client connesse per l'utente specificato HEAD /api/hubs/{hub}/users/{user}
Chiudere le connessioni per l'utente specifico. POST /api/hubs/{hub}/users/{user}/:closeConnections
Trasmettere un messaggio a tutti i client appartengono all'utente di destinazione. POST /api/hubs/{hub}/users/{user}/:send
Controllare se un utente esiste nel gruppo di destinazione. HEAD /api/hubs/{hub}/users/{user}/groups/{group}
Aggiungere un utente al gruppo di destinazione. PUT /api/hubs/{hub}/users/{user}/groups/{group}
Rimuovere un utente dal gruppo di destinazione. DELETE /api/hubs/{hub}/users/{user}/groups/{group}
Rimuovere un utente da tutti i gruppi. DELETE /api/hubs/{hub}/users/{user}/groups

/api/health

Riepilogo

Ottenere lo stato di integrità del servizio.

Ottenere lo stato di integrità del servizio

HEAD /api/health

Parametri
Nome Posizione Descrizione Richiesto Schema
api-version query Versione delle API REST. Sì string
Risposte
Codice Descrizione
200 Il servizio è integro
impostazione predefinita Risposta con errore

/api/hubs/{hub}/:closeConnections

POST

Riepilogo

Chiudere tutte le connessioni nell'hub.

Chiudere tutte le connessioni nell'hub

POST /api/hubs/{hub}/:closeConnections

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ì string
applicazione query Nome dell'applicazione di destinazione, che deve iniziare con caratteri alfabetici e contenere solo caratteri alfanumerici o caratteri di sottolineatura. No string
escluso query Escludere questi connectionId quando si chiudono le connessioni nell'hub. No [ string ]
reason query Motivo della chiusura delle connessioni client. No string
api-version query Versione delle API REST. Sì string
Risposte
Codice Descrizione Schema
204 Success
impostazione predefinita Risposta con errore ErrorDetail

/api/hubs/{hub}/:send

POST

Riepilogo

Trasmettere un messaggio a tutti i client connessi all'hub di destinazione.

Trasmettere un messaggio a tutti i client connessi all'hub di destinazione

POST /api/hubs/{hub}/:send

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ì string
applicazione query Nome dell'applicazione di destinazione, che deve iniziare con caratteri alfabetici e contenere solo caratteri alfanumerici o caratteri di sottolineatura. No string
escluso query ID connessione esclusi No [ string ]
api-version query Versione delle API REST. Sì string
messaggio body Messaggio di payload. Sì PayloadMessage
Risposte
Codice Descrizione Schema
202 Success ServiceResponse
impostazione predefinita Risposta con errore ErrorDetail

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

HEAD

Riepilogo

Controllare se la connessione con l'id connessione specificato esiste

Controllare se la connessione con l'id connessione specificato esiste

HEAD /api/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ì string
connectionId path ID connessione. Sì string
applicazione query Nome dell'applicazione di destinazione, che deve iniziare con caratteri alfabetici e contenere solo caratteri alfanumerici o caratteri di sottolineatura. No string
api-version query Versione delle API REST. Sì string
Risposte
Codice Descrizione Schema
200 Riuscita ServiceResponse
impostazione predefinita Risposta con errore ErrorDetail

DELETE

Riepilogo

Chiudere la connessione client

Chiudere la connessione client

DELETE /api/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ì string
connectionId path ID connessione. Sì string
applicazione query Nome dell'applicazione di destinazione, che deve iniziare con caratteri alfabetici e contenere solo caratteri alfanumerici o caratteri di sottolineatura. No string
reason query Motivo della chiusura della connessione. No string
api-version query Versione delle API REST. Sì string
Risposte
Codice Descrizione Schema
200 Riuscita ServiceResponse
impostazione predefinita Risposta con errore ErrorDetail

/api/hubs/{hub}/connections/{connectionId}/:send

POST

Riepilogo

Inviare un messaggio alla connessione specifica.

Inviare un messaggio alla connessione specifica

POST /api/hubs/{hub}/connections/{connectionId}/:send

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ì string
connectionId path ID connessione. Sì string
applicazione query Nome dell'applicazione di destinazione, che deve iniziare con caratteri alfabetici e contenere solo caratteri alfanumerici o caratteri di sottolineatura. No string
api-version query Versione delle API REST. Sì string
messaggio body Messaggio di payload. Sì PayloadMessage
Risposte
Codice Descrizione Schema
202 Success ServiceResponse
impostazione predefinita Risposta con errore ErrorDetail

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

HEAD

Riepilogo

Controllare se sono presenti connessioni client all'interno del gruppo specificato

Controllare se sono presenti connessioni client all'interno del gruppo specificato

HEAD /api/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ì string
group path Nome del gruppo di destinazione, la cui lunghezza deve essere maggiore di 0 e minore di 1025. Sì string
applicazione query Nome dell'applicazione di destinazione, che deve iniziare con caratteri alfabetici e contenere solo caratteri alfanumerici o caratteri di sottolineatura. No string
api-version query Versione delle API REST. Sì string
Risposte
Codice Descrizione Schema
200 Riuscita ServiceResponse
404 Non trovato
impostazione predefinita Risposta con errore ErrorDetail

/api/hubs/{hub}/groups/{group}/:closeConnections

POST

Riepilogo

Chiudere le connessioni nel gruppo specifico.

Chiudere le connessioni nel gruppo specifico

POST /api/hubs/{hub}/groups/{group}/:closeConnections

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ì string
group path Nome del gruppo di destinazione, la cui lunghezza deve essere maggiore di 0 e minore di 1025. Sì string
applicazione query Nome dell'applicazione di destinazione, che deve iniziare con caratteri alfabetici e contenere solo caratteri alfanumerici o caratteri di sottolineatura. No string
escluso query Escludere questi connectionId quando si chiudono le connessioni nell'hub. No [ string ]
reason query Motivo della chiusura delle connessioni client. No string
api-version query Versione delle API REST. Sì string
Risposte
Codice Descrizione Schema
204 Success
impostazione predefinita Risposta con errore ErrorDetail

/api/hubs/{hub}/groups/{group}/:send

POST

Riepilogo

Trasmettere un messaggio a tutti i client all'interno del gruppo di destinazione.

Trasmettere un messaggio a tutti i client all'interno del gruppo di destinazione

POST /api/hubs/{hub}/groups/{group}/:send

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ì string
group path Nome del gruppo di destinazione, la cui lunghezza deve essere maggiore di 0 e minore di 1025. Sì string
applicazione query Nome dell'applicazione di destinazione, che deve iniziare con caratteri alfabetici e contenere solo caratteri alfanumerici o caratteri di sottolineatura. No string
escluso query ID connessione esclusi No [ string ]
api-version query Versione delle API REST. Sì string
messaggio body Messaggio di payload. Sì PayloadMessage
Risposte
Codice Descrizione Schema
202 Success ServiceResponse
impostazione predefinita Risposta con errore ErrorDetail

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

PUT

Riepilogo

Aggiungere una connessione al gruppo di destinazione.

Aggiungere una connessione al gruppo di destinazione

PUT /api/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ì string
group path Nome del gruppo di destinazione, la cui lunghezza deve essere maggiore di 0 e minore di 1025. Sì string
connectionId path ID connessione di destinazione Sì string
applicazione query Nome dell'applicazione di destinazione, che deve iniziare con caratteri alfabetici e contenere solo caratteri alfanumerici o caratteri di sottolineatura. No string
api-version query Versione delle API REST. Sì string
Risposte
Codice Descrizione Schema
200 Riuscita ServiceResponse
404 Non trovato
impostazione predefinita Risposta con errore ErrorDetail

DELETE

Riepilogo

Rimuovere una connessione dal gruppo di destinazione.

Rimuovere una connessione dal gruppo di destinazione

DELETE /api/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ì string
group path Nome del gruppo di destinazione, la cui lunghezza deve essere maggiore di 0 e minore di 1025. Sì string
connectionId path ID connessione di destinazione Sì string
applicazione query Nome dell'applicazione di destinazione, che deve iniziare con caratteri alfabetici e contenere solo caratteri alfanumerici o caratteri di sottolineatura. No string
api-version query Versione delle API REST. Sì string
Risposte
Codice Descrizione Schema
200 Riuscita ServiceResponse
404 Non trovato
impostazione predefinita Risposta con errore ErrorDetail

/api/hubs/{hub}/connections/{connectionId}/groups

DELETE

Riepilogo

Rimuovere una connessione da tutti i gruppi

Rimuovere una connessione da tutti i gruppi

DELETE /api/hubs/{hub}/connections/{connectionId}/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ì string
connectionId path ID connessione di destinazione Sì string
applicazione query Nome dell'applicazione di destinazione, che deve iniziare con caratteri alfabetici e contenere solo caratteri alfanumerici o caratteri di sottolineatura. No string
api-version query Versione delle API REST. Sì string
Risposte
Codice Descrizione Schema
200 Riuscita ServiceResponse
impostazione predefinita Risposta con errore ErrorDetail

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

HEAD

Riepilogo

Controllare se sono presenti connessioni client connesse per l'utente specificato

Controllare se sono presenti connessioni client connesse per l'utente specificato

HEAD /api/hubs/{hub}/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ì string
utente path ID utente. Sì string
applicazione query Nome dell'applicazione di destinazione, che deve iniziare con caratteri alfabetici e contenere solo caratteri alfanumerici o caratteri di sottolineatura. No string
api-version query Versione delle API REST. Sì string
Risposte
Codice Descrizione Schema
200 Riuscita ServiceResponse
404 Non trovato
impostazione predefinita Risposta con errore ErrorDetail

/api/hubs/{hub}/users/{user}/:closeConnections

POST

Riepilogo

Chiudere le connessioni per l'utente specifico.

Chiudere le connessioni per l'utente specifico

POST /api/hubs/{hub}/users/{user}/:closeConnections

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ì string
utente path ID utente. Sì string
applicazione query Nome dell'applicazione di destinazione, che deve iniziare con caratteri alfabetici e contenere solo caratteri alfanumerici o caratteri di sottolineatura. No string
escluso query Escludere questi connectionId quando si chiudono le connessioni nell'hub. No [ string ]
reason query Motivo della chiusura delle connessioni client. No string
api-version query Versione delle API REST. Sì string
Risposte
Codice Descrizione Schema
204 Success
impostazione predefinita Risposta con errore ErrorDetail

/api/hubs/{hub}/users/{user}/:send

POST

Riepilogo

Trasmettere un messaggio a tutti i client appartengono all'utente di destinazione.

Trasmettere un messaggio a tutti i client appartengono all'utente di destinazione

POST /api/hubs/{hub}/users/{user}/:send

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ì string
utente path ID utente. Sì string
applicazione query Nome dell'applicazione di destinazione, che deve iniziare con caratteri alfabetici e contenere solo caratteri alfanumerici o caratteri di sottolineatura. No string
api-version query Versione delle API REST. Sì string
messaggio body Messaggio di payload. Sì PayloadMessage
Risposte
Codice Descrizione Schema
202 Success ServiceResponse
impostazione predefinita Risposta con errore ErrorDetail

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

HEAD

Riepilogo

Controllare se un utente esiste nel gruppo di destinazione.

Controllare se un utente esiste nel gruppo di destinazione

HEAD /api/hubs/{hub}/users/{user}/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ì string
group path Nome del gruppo di destinazione, la cui lunghezza deve essere maggiore di 0 e minore di 1025. Sì string
utente path ID utente di destinazione Sì string
applicazione query Nome dell'applicazione di destinazione, che deve iniziare con caratteri alfabetici e contenere solo caratteri alfanumerici o caratteri di sottolineatura. No string
api-version query Versione delle API REST. Sì string
Risposte
Codice Descrizione Schema
200 Riuscita ServiceResponse
404 Non trovato
impostazione predefinita Risposta con errore ErrorDetail

PUT

Riepilogo

Aggiungere un utente al gruppo di destinazione.

Aggiungere un utente al gruppo di destinazione

PUT /api/hubs/{hub}/users/{user}/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ì string
group path Nome del gruppo di destinazione, la cui lunghezza deve essere maggiore di 0 e minore di 1025. Sì string
utente path ID utente di destinazione Sì string
applicazione query Nome dell'applicazione di destinazione, che deve iniziare con caratteri alfabetici e contenere solo caratteri alfanumerici o caratteri di sottolineatura. No string
ttl query Specifica i secondi in cui l'utente esiste nel gruppo. Se non impostato, l'utente risiede al massimo nel gruppo per 1 anno. Se un utente viene aggiunto ad alcuni gruppi senza limitazione ttl, solo i gruppi aggiornati più recenti 100 verranno riservati tra tutti i gruppi aggiunti all'utente senza TTL. Se ttl = 0, al gruppo di destinazione verranno aggiunte solo le connessioni connesse correnti dell'utente di destinazione. No integer
api-version query Versione delle API REST. Sì string
Risposte
Codice Descrizione Schema
200 Riuscita ServiceResponse
impostazione predefinita Risposta con errore ErrorDetail

DELETE

Riepilogo

Rimuovere un utente dal gruppo di destinazione.

Rimuovere un utente dal gruppo di destinazione

DELETE /api/hubs/{hub}/users/{user}/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ì string
group path Nome del gruppo di destinazione, la cui lunghezza deve essere maggiore di 0 e minore di 1025. Sì string
utente path ID utente di destinazione Sì string
applicazione query Nome dell'applicazione di destinazione, che deve iniziare con caratteri alfabetici e contenere solo caratteri alfanumerici o caratteri di sottolineatura. No string
api-version query Versione delle API REST. Sì string
Risposte
Codice Descrizione Schema
204 Success
impostazione predefinita Risposta con errore ErrorDetail

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

DELETE

Riepilogo

Rimuovere un utente da tutti i gruppi.

Rimuovere un utente da tutti i gruppi

DELETE /api/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ì string
utente path ID utente di destinazione Sì string
applicazione query Nome dell'applicazione di destinazione, che deve iniziare con caratteri alfabetici e contenere solo caratteri alfanumerici o caratteri di sottolineatura. No string
api-version query Versione delle API REST. Sì string
Risposte
Codice Descrizione Schema
204 Success
impostazione predefinita Risposta con errore ErrorDetail

Modelli

ErrorDetail

Oggetto error.

Nome Tipo Descrizione Richiesto
codice string Uno di un set definito dal server di codici di errore. No
messaggio string Rappresentazione leggibile dell'errore. No
bersaglio string Destinazione dell'errore. No
dettagli [ ErrorDetail ] Matrice di dettagli sugli errori specifici che hanno causato l'errore segnalato. No
interno InnerError No

InnerError

Nome Tipo Descrizione Richiesto
codice string Codice di errore più specifico di quello fornito dall'errore contenitore. No
interno InnerError No

PayloadMessage

Nome Tipo Descrizione Richiesto
bersaglio string Sì
argomenti [ ] No

ServiceResponse

Nome Tipo Descrizione Richiesto
codice string No
level string Enumerazione: "Info", "Warning", "Error" No
ambito string Enumerazione: "Unknown", "Request", "Connection", "User", "Group" No
errorKind string Enumerazione: "Unknown", "NotExisted", "NotInGroup", "Invalid" No
messaggio string No
jsonObject No
isSuccess boolean No