REST API för Azure SignalR Service-dataplan – v1

Den här artikeln innehåller rest-API:er för v1-versionen för Azure SignalR Service-dataplanet.

Tillgängliga API:er

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

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

POST /api/v1/hubs/{hub}

Parameters

Name	Finns i	Description	Obligatoriskt	Schema
Nav	path	Målhubbens namn, som måste börja med alfabetiska tecken och endast innehålla alfanumeriska tecken eller understreck.	Ja	sträng
Uteslutna	query	Undantagna anslutnings-ID:t	Inga	[ sträng ]

Svar

Kod	Description
202	Klart
400	Felaktig förfrågan

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

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

Parameters

Name	Finns i	Description	Obligatoriskt	Schema
Nav	path	Målhubbens namn, som måste börja med alfabetiska tecken och endast innehålla alfanumeriska tecken eller understreck.	Ja	sträng
id	path	Användar-ID:t.	Ja	sträng

Svar

Kod	Description
202	Klart
400	Felaktig förfrågan

Skicka ett meddelande till den specifika anslutningen.

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

Parameters

Name	Finns i	Description	Obligatoriskt	Schema
Nav	path	Målhubbens namn, som måste börja med alfabetiska tecken och endast innehålla alfanumeriska tecken eller understreck.	Ja	sträng
connectionId	path	Anslutnings-ID:t.	Ja	sträng

Svar

Kod	Description
202	Klart
400	Felaktig förfrågan

Kontrollera om anslutningen med det angivna connectionId:et finns

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

Parameters

Name	Finns i	Description	Obligatoriskt	Schema
Nav	path		Ja	sträng
connectionId	path		Ja	sträng

Svar

Kod	Description
200	Framgång
400	Felaktig förfrågan
404	Hittades inte

Stäng klientanslutningen

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

Parameters

Name	Finns i	Description	Obligatoriskt	Schema
Nav	path		Ja	sträng
connectionId	path		Ja	sträng
orsak	query		Inga	sträng

Svar

Kod	Description
202	Klart
400	Felaktig förfrågan

Skicka ett meddelande till alla klienter i målgruppen.

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

Parameters

Name	Finns i	Description	Obligatoriskt	Schema
Nav	path	Målhubbens namn, som måste börja med alfabetiska tecken och endast innehålla alfanumeriska tecken eller understreck.	Ja	sträng
grupp	path	Målgruppens namn, vars längd måste vara större än 0 och mindre än 1025.	Ja	sträng
Uteslutna	query	Undantagna anslutnings-ID:t	Inga	[ sträng ]

Svar

Kod	Description
202	Klart
400	Felaktig förfrågan

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

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

Parameters

Name	Finns i	Description	Obligatoriskt	Schema
Nav	path		Ja	sträng
grupp	path		Ja	sträng

Svar

Kod	Description
200	Framgång
400	Felaktig förfrågan
404	Hittades inte

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

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

Parameters

Name	Finns i	Description	Obligatoriskt	Schema
Nav	path		Ja	sträng
användare	path		Ja	sträng

Svar

Kod	Description
200	Framgång
400	Felaktig förfrågan
404	Hittades inte

Lägg till en anslutning till målgruppen.

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

Parameters

Name	Finns i	Description	Obligatoriskt	Schema
Nav	path	Målhubbens namn, som måste börja med alfabetiska tecken och endast innehålla alfanumeriska tecken eller understreck.	Ja	sträng
grupp	path	Målgruppens namn, vars längd måste vara större än 0 och mindre än 1025.	Ja	sträng
connectionId	path	Målanslutnings-ID	Ja	sträng

Svar

Kod	Description
200	Framgång
400	Felaktig förfrågan
404	Hittades inte

Ta bort en anslutning från målgruppen.

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

Parameters

Name	Finns i	Description	Obligatoriskt	Schema
Nav	path	Målhubbens namn, som måste börja med alfabetiska tecken och endast innehålla alfanumeriska tecken eller understreck.	Ja	sträng
grupp	path	Målgruppens namn, vars längd måste vara större än 0 och mindre än 1025.	Ja	sträng
connectionId	path	Målanslutnings-ID	Ja	sträng

Svar

Kod	Description
200	Framgång
400	Felaktig förfrågan
404	Hittades inte

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

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

Parameters

Name	Finns i	Description	Obligatoriskt	Schema
Nav	path	Målhubbens namn, som måste börja med alfabetiska tecken och endast innehålla alfanumeriska tecken eller understreck.	Ja	sträng
grupp	path	Målgruppens namn, vars längd måste vara större än 0 och mindre än 1025.	Ja	sträng
användare	path	Målanvändar-ID	Ja	sträng

Svar

Kod	Description
200	Framgång
400	Felaktig förfrågan
404	Hittades inte

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

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

Parameters

Name	Finns i	Description	Obligatoriskt	Schema
Nav	path	Målhubbens namn, som måste börja med alfabetiska tecken och endast innehålla alfanumeriska tecken eller understreck.	Ja	sträng
grupp	path	Målgruppens namn, vars längd måste vara större än 0 och mindre än 1025.	Ja	sträng
användare	path	Målanvändar-ID	Ja	sträng
ttl	query	Anger de sekunder som användaren finns i gruppen. Om den inte har angetts finns användaren i gruppen i högst 1 år. Observera att när ttl inte har angetts bevarar tjänsten 100 användargruppsrelationer per användare och gammal användargruppsrelation skrivs över av nyligen tillagda relationer.	Inga	integer

Svar

Kod	Description
202	Klart
400	Felaktig förfrågan

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

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

Parameters

Name	Finns i	Description	Obligatoriskt	Schema
Nav	path	Målhubbens namn, som måste börja med alfabetiska tecken och endast innehålla alfanumeriska tecken eller understreck.	Ja	sträng
grupp	path	Målgruppens namn, vars längd måste vara större än 0 och mindre än 1025.	Ja	sträng
användare	path	Målanvändar-ID	Ja	sträng

Svar

Kod	Description
202	Klart
400	Felaktig förfrågan

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

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

Parameters

Name	Finns i	Description	Obligatoriskt	Schema
Nav	path	Målhubbens namn, som måste 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

Svar

Kod	Description
200	Användaren tas bort
202	Borttagningsbegäran godkänns och tjänsten hanterar begäran i bakgrunden
400	Felaktig förfrågan

Modeller

PayloadMessage

Namn	Type	Beskrivning	Obligatoriskt
Mål	sträng		Inga
Argument	[ objekt ]		Inga