Dela via

Azure SignalR Service REST API

Version: 2022-06-01

Tillgängliga API:er

API Sökväg
Hämta status för tjänstens hälsotillstånd. HEAD /api/health
Stäng alla anslutningar i hubben. POST /api/hubs/{hub}/:closeConnections
Skicka ett meddelande till alla klienter som är anslutna till målhubben. POST /api/hubs/{hub}/:send
Kontrollera om anslutningen med det angivna connectionId:et finns HEAD /api/hubs/{hub}/connections/{connectionId}
Stäng klientanslutningen DELETE /api/hubs/{hub}/connections/{connectionId}
Skicka ett meddelande till den specifika anslutningen. POST /api/hubs/{hub}/connections/{connectionId}/:send
Kontrollera om det finns några klientanslutningar i den angivna gruppen HEAD /api/hubs/{hub}/groups/{group}
Stäng anslutningar i den specifika gruppen. POST /api/hubs/{hub}/groups/{group}/:closeConnections
Skicka ett meddelande till alla klienter i målgruppen. POST /api/hubs/{hub}/groups/{group}/:send
Lägg till en anslutning till målgruppen. PUT /api/hubs/{hub}/groups/{group}/connections/{connectionId}
Ta bort en anslutning från målgruppen. DELETE /api/hubs/{hub}/groups/{group}/connections/{connectionId}
Ta bort en anslutning från alla grupper DELETE /api/hubs/{hub}/connections/{connectionId}/groups
Kontrollera om det finns några anslutna klientanslutningar för den angivna användaren HEAD /api/hubs/{hub}/users/{user}
Stäng anslutningar för den specifika användaren. POST /api/hubs/{hub}/users/{user}/:closeConnections
Skicka ett meddelande till alla klienter som tillhör målanvändaren. POST /api/hubs/{hub}/users/{user}/:send
Kontrollera om en användare finns i målgruppen. HEAD /api/hubs/{hub}/users/{user}/groups/{group}
Lägg till en användare i målgruppen. PUT /api/hubs/{hub}/users/{user}/groups/{group}
Ta bort en användare från målgruppen. DELETE /api/hubs/{hub}/users/{user}/groups/{group}
Ta bort en användare från alla grupper. DELETE /api/hubs/{hub}/users/{user}/groups

/api/health

Sammanfattning

Hämta status för tjänstens hälsotillstånd.

Hämta status för tjänstens hälsotillstånd

HEAD /api/health

Parameters
Name Finns i beskrivning Obligatoriskt Schema
api-version query Versionen av REST-API:erna. Ja sträng
Svar
Kod beskrivning
200 Tjänsten är felfri
standard Felsvar

/api/hubs/{hub}/:closeConnections

POST

Sammanfattning

Stäng alla anslutningar i hubben.

Stäng alla anslutningar i hubben

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

Parameters
Name Finns i beskrivning Obligatoriskt Schema
nav path Målhubbens namn, som ska börja med alfabetiska tecken och endast innehålla alfanumeriska tecken eller understreck. Ja sträng
program query Målprogrammets namn, som ska börja med alfabetiska tecken och endast innehålla alfanumeriska tecken eller understreck. Nej sträng
utesluten query Exkludera dessa connectionIds när du stänger anslutningarna i hubben. Nej [ sträng ]
orsak query Orsaken till att klientanslutningarna stängs. Nej sträng
api-version query Versionen av REST-API:erna. Ja sträng
Svar
Kod beskrivning Schema
204 Klart
standard Felsvar ErrorDetail

/api/hubs/{hub}/:send

POST

Sammanfattning

Skicka ett meddelande till alla klienter som är anslutna till målhubben.

Skicka ett meddelande till alla klienter som är anslutna till målhubben

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

Parameters
Name Finns i beskrivning Obligatoriskt Schema
nav path Målhubbens namn, som ska börja med alfabetiska tecken och endast innehålla alfanumeriska tecken eller understreck. Ja sträng
program query Målprogrammets namn, som ska börja med alfabetiska tecken och endast innehålla alfanumeriska tecken eller understreck. Nej sträng
utesluten query Undantagna anslutnings-ID:t Nej [ sträng ]
api-version query Versionen av REST-API:erna. Ja sträng
meddelande brödtext Nyttolastmeddelandet. Ja PayloadMessage
Svar
Kod beskrivning Schema
202 Klart ServiceResponse
standard Felsvar ErrorDetail

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

HEAD

Sammanfattning

Kontrollera om anslutningen med det angivna connectionId:et finns

Kontrollera om anslutningen med det angivna connectionId:et finns

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

Parameters
Name Finns i beskrivning Obligatoriskt Schema
nav path Målhubbens namn, som ska börja med alfabetiska tecken och endast innehålla alfanumeriska tecken eller understreck. Ja sträng
connectionId path Anslutnings-ID:t. Ja sträng
program query Målprogrammets namn, som ska börja med alfabetiska tecken och endast innehålla alfanumeriska tecken eller understreck. Nej sträng
api-version query Versionen av REST-API:erna. Ja sträng
Svar
Kod beskrivning Schema
200 Framgång ServiceResponse
standard Felsvar ErrorDetail

DELETE

Sammanfattning

Stäng klientanslutningen

Stäng klientanslutningen

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

Parameters
Name Finns i beskrivning Obligatoriskt Schema
nav path Målhubbens namn, som ska börja med alfabetiska tecken och endast innehålla alfanumeriska tecken eller understreck. Ja sträng
connectionId path Anslutnings-ID:t. Ja sträng
program query Målprogrammets namn, som ska börja med alfabetiska tecken och endast innehålla alfanumeriska tecken eller understreck. Nej sträng
orsak query Orsaken till anslutningen stängs. Nej sträng
api-version query Versionen av REST-API:erna. Ja sträng
Svar
Kod beskrivning Schema
200 Framgång ServiceResponse
standard Felsvar ErrorDetail

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

POST

Sammanfattning

Skicka ett meddelande till den specifika anslutningen.

Skicka meddelande till den specifika anslutningen

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

Parameters
Name Finns i beskrivning Obligatoriskt Schema
nav path Målhubbens namn, som ska börja med alfabetiska tecken och endast innehålla alfanumeriska tecken eller understreck. Ja sträng
connectionId path Anslutnings-ID:t. Ja sträng
program query Målprogrammets namn, som ska börja med alfabetiska tecken och endast innehålla alfanumeriska tecken eller understreck. Nej sträng
api-version query Versionen av REST-API:erna. Ja sträng
meddelande brödtext Nyttolastmeddelandet. Ja PayloadMessage
Svar
Kod beskrivning Schema
202 Klart ServiceResponse
standard Felsvar ErrorDetail

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

HEAD

Sammanfattning

Kontrollera om det finns några klientanslutningar i den angivna gruppen

Kontrollera om det finns några klientanslutningar i den angivna gruppen

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

Parameters
Name Finns i beskrivning Obligatoriskt Schema
nav path Målhubbens namn, som ska börja med alfabetiska tecken och endast innehålla alfanumeriska tecken eller understreck. Ja sträng
grupp path Målgruppens namn, som ska vara större än 0 och mindre än 1025. Ja sträng
program query Målprogrammets namn, som ska börja med alfabetiska tecken och endast innehålla alfanumeriska tecken eller understreck. Nej sträng
api-version query Versionen av REST-API:erna. Ja sträng
Svar
Kod beskrivning Schema
200 Framgång ServiceResponse
404 Hittades inte
standard Felsvar ErrorDetail

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

POST

Sammanfattning

Stäng anslutningar i den specifika gruppen.

Stänga anslutningar i den specifika gruppen

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

Parameters
Name Finns i beskrivning Obligatoriskt Schema
nav path Målhubbens namn, som ska börja med alfabetiska tecken och endast innehålla alfanumeriska tecken eller understreck. Ja sträng
grupp path Målgruppens namn, som ska vara större än 0 och mindre än 1025. Ja sträng
program query Målprogrammets namn, som ska börja med alfabetiska tecken och endast innehålla alfanumeriska tecken eller understreck. Nej sträng
utesluten query Exkludera dessa connectionIds när du stänger anslutningarna i hubben. Nej [ sträng ]
orsak query Orsaken till att klientanslutningarna stängs. Nej sträng
api-version query Versionen av REST-API:erna. Ja sträng
Svar
Kod beskrivning Schema
204 Klart
standard Felsvar ErrorDetail

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

POST

Sammanfattning

Skicka ett meddelande till alla klienter i målgruppen.

Skicka ett meddelande till alla klienter i målgruppen

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

Parameters
Name Finns i beskrivning Obligatoriskt Schema
nav path Målhubbens namn, som ska börja med alfabetiska tecken och endast innehålla alfanumeriska tecken eller understreck. Ja sträng
grupp path Målgruppens namn, som ska vara större än 0 och mindre än 1025. Ja sträng
program query Målprogrammets namn, som ska börja med alfabetiska tecken och endast innehålla alfanumeriska tecken eller understreck. Nej sträng
utesluten query Undantagna anslutnings-ID:t Nej [ sträng ]
api-version query Versionen av REST-API:erna. Ja sträng
meddelande brödtext Nyttolastmeddelandet. Ja PayloadMessage
Svar
Kod beskrivning Schema
202 Klart ServiceResponse
standard Felsvar ErrorDetail

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

PUT

Sammanfattning

Lägg till en anslutning till målgruppen.

Lägga till en anslutning till målgruppen

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

Parameters
Name Finns i beskrivning Obligatoriskt Schema
nav path Målhubbens namn, som ska börja med alfabetiska tecken och endast innehålla alfanumeriska tecken eller understreck. Ja sträng
grupp path Målgruppens namn, som ska vara större än 0 och mindre än 1025. Ja sträng
connectionId path Målanslutnings-ID Ja sträng
program query Målprogrammets namn, som ska börja med alfabetiska tecken och endast innehålla alfanumeriska tecken eller understreck. Nej sträng
api-version query Versionen av REST-API:erna. Ja sträng
Svar
Kod beskrivning Schema
200 Framgång ServiceResponse
404 Hittades inte
standard Felsvar ErrorDetail

DELETE

Sammanfattning

Ta bort en anslutning från målgruppen.

Ta bort en anslutning från målgruppen

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

Parameters
Name Finns i beskrivning Obligatoriskt Schema
nav path Målhubbens namn, som ska börja med alfabetiska tecken och endast innehålla alfanumeriska tecken eller understreck. Ja sträng
grupp path Målgruppens namn, som ska vara större än 0 och mindre än 1025. Ja sträng
connectionId path Målanslutnings-ID Ja sträng
program query Målprogrammets namn, som ska börja med alfabetiska tecken och endast innehålla alfanumeriska tecken eller understreck. Nej sträng
api-version query Versionen av REST-API:erna. Ja sträng
Svar
Kod beskrivning Schema
200 Framgång ServiceResponse
404 Hittades inte
standard Felsvar ErrorDetail

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

DELETE

Sammanfattning

Ta bort en anslutning från alla grupper

Ta bort en anslutning från alla grupper

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

Parameters
Name Finns i beskrivning Obligatoriskt Schema
nav path Målhubbens namn, som ska börja med alfabetiska tecken och endast innehålla alfanumeriska tecken eller understreck. Ja sträng
connectionId path Målanslutnings-ID Ja sträng
program query Målprogrammets namn, som ska börja med alfabetiska tecken och endast innehålla alfanumeriska tecken eller understreck. Nej sträng
api-version query Versionen av REST-API:erna. Ja sträng
Svar
Kod beskrivning Schema
200 Framgång ServiceResponse
standard Felsvar ErrorDetail

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

HEAD

Sammanfattning

Kontrollera om det finns några anslutna klientanslutningar för den angivna användaren

Kontrollera om det finns några anslutna klientanslutningar för den angivna användaren

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

Parameters
Name Finns i beskrivning Obligatoriskt Schema
nav path Målhubbens namn, som ska börja med alfabetiska tecken och endast innehålla alfanumeriska tecken eller understreck. Ja sträng
användare path Användar-ID:t. Ja sträng
program query Målprogrammets namn, som ska börja med alfabetiska tecken och endast innehålla alfanumeriska tecken eller understreck. Nej sträng
api-version query Versionen av REST-API:erna. Ja sträng
Svar
Kod beskrivning Schema
200 Framgång ServiceResponse
404 Hittades inte
standard Felsvar ErrorDetail

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

POST

Sammanfattning

Stäng anslutningar för den specifika användaren.

Stänga anslutningar för den specifika användaren

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

Parameters
Name Finns i beskrivning Obligatoriskt Schema
nav path Målhubbens namn, som ska börja med alfabetiska tecken och endast innehålla alfanumeriska tecken eller understreck. Ja sträng
användare path Användar-ID:t. Ja sträng
program query Målprogrammets namn, som ska börja med alfabetiska tecken och endast innehålla alfanumeriska tecken eller understreck. Nej sträng
utesluten query Exkludera dessa connectionIds när du stänger anslutningarna i hubben. Nej [ sträng ]
orsak query Orsaken till att klientanslutningarna stängs. Nej sträng
api-version query Versionen av REST-API:erna. Ja sträng
Svar
Kod beskrivning Schema
204 Klart
standard Felsvar ErrorDetail

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

POST

Sammanfattning

Skicka ett meddelande till alla klienter som tillhör målanvändaren.

Skicka ett meddelande till alla klienter som tillhör målanvändaren

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

Parameters
Name Finns i beskrivning Obligatoriskt Schema
nav path Målhubbens namn, som ska börja med alfabetiska tecken och endast innehålla alfanumeriska tecken eller understreck. Ja sträng
användare path Användar-ID:t. Ja sträng
program query Målprogrammets namn, som ska börja med alfabetiska tecken och endast innehålla alfanumeriska tecken eller understreck. Nej sträng
api-version query Versionen av REST-API:erna. Ja sträng
meddelande brödtext Nyttolastmeddelandet. Ja PayloadMessage
Svar
Kod beskrivning Schema
202 Klart ServiceResponse
standard Felsvar ErrorDetail

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

HEAD

Sammanfattning

Kontrollera om en användare finns i målgruppen.

Kontrollera om en användare finns i målgruppen

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

Parameters
Name Finns i beskrivning Obligatoriskt Schema
nav path Målhubbens namn, som ska börja med alfabetiska tecken och endast innehålla alfanumeriska tecken eller understreck. Ja sträng
grupp path Målgruppens namn, som ska vara större än 0 och mindre än 1025. Ja sträng
användare path Målanvändar-ID Ja sträng
program query Målprogrammets namn, som ska börja med alfabetiska tecken och endast innehålla alfanumeriska tecken eller understreck. Nej sträng
api-version query Versionen av REST-API:erna. Ja sträng
Svar
Kod beskrivning Schema
200 Framgång ServiceResponse
404 Hittades inte
standard Felsvar ErrorDetail

PUT

Sammanfattning

Lägg till en användare i målgruppen.

Lägga till en användare i målgruppen

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

Parameters
Name Finns i beskrivning Obligatoriskt Schema
nav path Målhubbens namn, som ska börja med alfabetiska tecken och endast innehålla alfanumeriska tecken eller understreck. Ja sträng
grupp path Målgruppens namn, som ska vara större än 0 och mindre än 1025. Ja sträng
användare path Målanvändar-ID Ja sträng
program query Målprogrammets namn, som ska börja med alfabetiska tecken och endast innehålla alfanumeriska tecken eller understreck. Nej sträng
ttl query Anger de sekunder som användaren finns i gruppen. Om den inte har angetts finns användaren högst i gruppen i högst 1 år. Om en användare läggs till i vissa grupper utan ttl-begränsning reserveras endast de senaste uppdaterade 100 grupperna mellan alla grupper som användaren har anslutit utan TTL. Om ttl = 0 läggs endast de aktuella anslutna anslutningarna för målanvändaren till i målgruppen. Nej integer
api-version query Versionen av REST-API:erna. Ja sträng
Svar
Kod beskrivning Schema
200 Framgång ServiceResponse
standard Felsvar ErrorDetail

DELETE

Sammanfattning

Ta bort en användare från målgruppen.

Ta bort en användare från målgruppen

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

Parameters
Name Finns i beskrivning Obligatoriskt Schema
nav path Målhubbens namn, som ska börja med alfabetiska tecken och endast innehålla alfanumeriska tecken eller understreck. Ja sträng
grupp path Målgruppens namn, som ska vara större än 0 och mindre än 1025. Ja sträng
användare path Målanvändar-ID Ja sträng
program query Målprogrammets namn, som ska börja med alfabetiska tecken och endast innehålla alfanumeriska tecken eller understreck. Nej sträng
api-version query Versionen av REST-API:erna. Ja sträng
Svar
Kod beskrivning Schema
204 Klart
standard Felsvar ErrorDetail

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

DELETE

Sammanfattning

Ta bort en användare från alla grupper.

Ta bort en användare från alla grupper

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

Parameters
Name Finns i beskrivning Obligatoriskt Schema
nav path Målhubbens namn, som ska börja med alfabetiska tecken och endast innehålla alfanumeriska tecken eller understreck. Ja sträng
användare path Målanvändar-ID Ja sträng
program query Målprogrammets namn, som ska börja med alfabetiska tecken och endast innehålla alfanumeriska tecken eller understreck. Nej sträng
api-version query Versionen av REST-API:erna. Ja sträng
Svar
Kod beskrivning Schema
204 Klart
standard Felsvar ErrorDetail

Modeller

ErrorDetail

Felobjektet.

Namn Type Beskrivning Obligatoriskt
kod sträng En av en serverdefinierad uppsättning felkoder. Nej
meddelande sträng En mänsklig läsbar representation av felet. Nej
mål sträng Felets mål. Nej
information [ ErrorDetail ] En matris med information om specifika fel som ledde till det rapporterade felet. Nej
inre InnerError Nej

InnerError

Namn Type Beskrivning Obligatoriskt
kod sträng En mer specifik felkod än vad som angavs av det innehållande felet. Nej
inre InnerError Nej

PayloadMessage

Namn Type Beskrivning Obligatoriskt
mål sträng Ja
Argument [ ] Nej

ServiceResponse

Namn Type Beskrivning Obligatoriskt
kod string Nej
nivå sträng Uppräkning: "Info", "Warning", "Error" Nej
omfattning sträng Uppräkning: "Unknown", "Request", "Connection", "User", "Group" Nej
errorKind sträng Uppräkning: "Unknown", "NotExisted", "NotInGroup", "Invalid" Nej
meddelande sträng Nej
jsonObject Nej
isSuccess boolean Nej