Azure SignalR Service

Azure SignalR Service SignalR API

SignalR operations

GitHub OpenAPI
Business capability
IT Infrastructure Management BC-600.50

Operations 69

GET /providers/Microsoft.SignalRService/operations Operations list #
POST /subscriptions/{subscriptionId}/providers/Microsoft.SignalRService/locations/{location}/checkNameAvailability Signal R check name availability #
GET /subscriptions/{subscriptionId}/providers/Microsoft.SignalRService/locations/{location}/usages Usages list #
GET /subscriptions/{subscriptionId}/providers/Microsoft.SignalRService/signalR Signal R list by subscription #
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR Signal R list by resource group #
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName} Signal R get #
PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName} Signal R create or update #
DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName} Signal R delete #
PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName} Signal R update #
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/customCertificates Signal RCustom certificates list #
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/customCertificates/{certificateName} Signal RCustom certificates get #
PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/customCertificates/{certificateName} Signal RCustom certificates create or update #
DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/customCertificates/{certificateName} Signal RCustom certificates delete #
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/customDomains Signal RCustom domains list #
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/customDomains/{name} Signal RCustom domains get #
PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/customDomains/{name} Signal RCustom domains create or update #
DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/customDomains/{name} Signal RCustom domains delete #
POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/listKeys Signal R list keys #
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/privateEndpointConnections Signal RPrivate endpoint connections list #
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName} Signal RPrivate endpoint connections get #
PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName} Signal RPrivate endpoint connections update #
DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName} Signal RPrivate endpoint connections delete #
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/privateLinkResources Signal RPrivate link resources list #
POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/regenerateKey Signal R regenerate key #
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/replicas Signal RReplicas list #
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/replicas/{replicaName} Signal RReplicas get #
PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/replicas/{replicaName} Signal RReplicas create or update #
DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/replicas/{replicaName} Signal RReplicas delete #
PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/replicas/{replicaName} Signal RReplicas update #
POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/replicas/{replicaName}/restart Signal RReplicas restart #
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/replicas/{replicaName}/sharedPrivateLinkResources Signal RReplica shared private link resources list #
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/replicas/{replicaName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName} Signal RReplica shared private link resources get #
PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/replicas/{replicaName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName} Signal RReplica shared private link resources create or update #
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/replicas/{replicaName}/skus Signal R list replica skus #
POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/restart Signal R restart #
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/sharedPrivateLinkResources Signal RShared private link resources list #
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName} Signal RShared private link resources get #
PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName} Signal RShared private link resources create or update #
DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName} Signal RShared private link resources delete #
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/skus Signal R list skus #
GET /api/auth/accessKey Auth get access key #
POST /api/hubs/{hub}/:closeConnections Close all of the connections in the hub #
POST /api/hubs/{hub}/:execute Execute commands in transaction for all of connections #
POST /api/hubs/{hub}/:generateToken Generate token for the client to connect Azure SignalR service #
POST /api/hubs/{hub}/:send Broadcast a message to all clients connected to target hub #
DELETE /api/hubs/{hub}/connections/{connectionId} Close the client connection #
HEAD /api/hubs/{hub}/connections/{connectionId} Check if the connection with the given connectionId exists #
POST /api/hubs/{hub}/connections/{connectionId}/:invoke Invoke a method on a connection #
POST /api/hubs/{hub}/connections/{connectionId}/:send Send message to the specific connection #
DELETE /api/hubs/{hub}/connections/{connectionId}/groups Remove a connection from all groups #
POST /api/hubs/{hub}/connections/{connectionId}/streams/{streamId}/:complete Complete a streaming for the specific connection #
POST /api/hubs/{hub}/connections/{connectionId}/streams/{streamId}/:send Send stream message to the specific stream for the connection #
HEAD /api/hubs/{hub}/groups/{group} Check if there are any client connections inside the given group #
POST /api/hubs/{hub}/groups/{group}/:closeConnections Close connections in the specific group #
POST /api/hubs/{hub}/groups/{group}/:send Broadcast a message to all clients within the target group #
GET /api/hubs/{hub}/groups/{group}/connections List connections in a group #
DELETE /api/hubs/{hub}/groups/{group}/connections/{connectionId} Remove a connection from the target group #
PUT /api/hubs/{hub}/groups/{group}/connections/{connectionId} Add a connection to the target group #
HEAD /api/hubs/{hub}/users/{user} Check if there are any client connections connected for the given user #
POST /api/hubs/{hub}/users/{user}/:closeConnections Close connections for the specific user #
POST /api/hubs/{hub}/users/{user}/:send Broadcast a message to all clients belong to the target user #
DELETE /api/hubs/{hub}/users/{user}/groups Remove a user from all groups #
DELETE /api/hubs/{hub}/users/{user}/groups/{group} Remove a user from the target group #
HEAD /api/hubs/{hub}/users/{user}/groups/{group} Check whether a user exists in the target group #
PUT /api/hubs/{hub}/users/{user}/groups/{group} Add a user to the target group #
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{name} Azure SignalR Service REST API Get resource #
PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{name} Azure SignalR Service REST API Create or update resource #
PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{name} Azure SignalR Service REST API Update resource #
DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{name} Azure SignalR Service REST API Delete resource #

Documentation

📖
Documentation
https://learn.microsoft.com/en-us/rest/api/signalr/
📖
Authentication
https://learn.microsoft.com/en-us/azure/active-directory/develop/authentication-flows-app-scenarios

Specifications

⚙
OpenAPI
https://artifacts.apis.io/microsoft-azure-signalr/openapi/microsoft-azure-signalr-signalr-api-openapi.yml
⚙
OpenAPI
https://raw.githubusercontent.com/Azure/azure-rest-api-specs/main/specification/signalr/resource-manager/Microsoft.SignalRService/SignalRService/stable/2024-03-01/signalr.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/microsoft-azure-signalr:microsoft-azure-signalr-signalr-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

microsoft-azure-signalr-signalr-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Microsoft Azure Signal R API
  version: '1.0'
  description: 'Operations tagged SignalR across 4 of this provider''s published API definitions: microsoft-azure-signalr-arm-2024-03-01.json, microsoft-azure-signalr-dataplane-v20241201.json, microsoft-azure-signalr-openapi.yml, microsoft-azure-signalr-data-plane-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://management.azure.com
tags:


# --- truncated at 32 KB (176 KB total) ---
# Full source: https://artifacts.apis.io/microsoft-azure-signalr/openapi/microsoft-azure-signalr-signalr-api-openapi.yml