Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Release1.18.1 #1635

Merged
merged 7 commits into from
Jun 28, 2022
Merged

Release1.18.1 #1635

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
596d68e
Update `Serverless.Protocols` version to 1.9.0 (#1628)
Y-Sindo Jun 8, 2022
1a5ecc4
Obsolete UseAzureSignalR (#1605)
xingsy97 Jun 8, 2022
f979457
Merge branch 'master' of https://github.com/Azure/azure-signalr into dev
Y-Sindo Jun 15, 2022
97e5660
Merge master back
Y-Sindo Jun 15, 2022
c87f2da
Update rest-api.md to redirect to docs (#1630)
vicancy Jun 21, 2022
3616e98
When it is NotActive no need to log error (#1631)
vicancy Jun 28, 2022
0ac1694
Update version.props (#1634)
vicancy Jun 28, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
142 changes: 1 addition & 141 deletions docs/rest-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,143 +1,3 @@
# REST API in Azure SignalR Service

> **NOTE**
>
> Azure SignalR Service only supports using REST API to manage clients connected using ASP.NET Core SignalR. Clients connected using ASP.NET SignalR use a different data protocol and is now not supported.

- [REST API in Azure SignalR Service](#rest-api-in-azure-signalr-service)
- [Typical Server-less Architecture with Azure Functions](#typical-server-less-architecture-with-azure-functions)
- [API](#api)
- [Using REST API](#using-rest-api)
- [Authenticate via Azure SignalR Service AccessKey](#authenticate-via-azure-signalr-service-accesskey)
- [Signing Algorithm and Signature](#signing-algorithm-and-signature)
- [Claims](#claims)
- [Authenticate via Azure Active Directory Token (AAD Token)](#authenticate-via-azure-active-directory-token-aad-token)
- [Implement Negotiate Endpoint](#implement-negotiate-endpoint)
- [User-related REST API](#user-related-rest-api)
- [Sample](#sample)
- [Limitation](#limitation)

On top of classical client-server pattern, Azure SignalR Service provides a set of REST APIs, so that you can easily integrate real-time functionality into your server-less architecture.

<a name="serverless"></a>
## Typical Server-less Architecture with Azure Functions

The following diagram shows a typical server-less architecture of using Azure SignalR Service with Azure Functions.

![Typical Serverless Architecture](./images/serverless-arch.png)

- `negotiate` function will return negotiation response and redirect all clients to Azure SignalR Service.
- `broadcast` function will call Azure SignalR Service's REST API. Then SignalR Service will broadcast the message to all connected clients.

In server-less architecture, clients still have persistent connections to Azure SignalR Service.
Since there are no application server to handle traffic, clients are in `LISTEN` mode, which means they can only receive messages but can't send messages.
SignalR Service will disconnect any client who sends messages because it is an invalid operation.

You can find a complete sample of using Azure SignalR Service with Azure Functions at [here](https://github.com/aspnet/AzureSignalR-samples/tree/master/samples/RealtimeSignIn).

## API

The following table shows all versions of REST API we have for now. You can also find the swagger file for each version of REST API.

API Version | Status | Port | Doc | Spec
---|---|---|---|---
`1.0-preview` | Obsolete | Standard | [Doc](./swagger/v1-preview.md) | [swagger](./swagger/v1-preview.json)
`1.0` | Available | Standard | [Doc](./swagger/v1.md) | [swagger](./swagger/v1.json)

The latest available APIs are listed as following.


| API | Path |
| ---- | ---------- |
| [Broadcast a message to all clients connected to target hub.](./swagger/v1.md#post-broadcast-a-message-to-all-clients-connected-to-target-hub.) | `POST /api/v1/hubs/{hub}` |
| [Broadcast a message to all clients belong to the target user.](./swagger/v1.md#post-broadcast-a-message-to-all-clients-belong-to-the-target-user.) | `POST /api/v1/hubs/{hub}/users/{id}` |
| [Send message to the specific connection.](./swagger/v1.md#post-send-message-to-the-specific-connection.) | `POST /api/v1/hubs/{hub}/connections/{connectionId}` |
| [Check if the connection with the given connectionId exists](./swagger/v1.md#get-check-if-the-connection-with-the-given-connectionid-exists) | `GET /api/v1/hubs/{hub}/connections/{connectionId}` |
| [Close the client connection](./swagger/v1.md#delete-close-the-client-connection) | `DELETE /api/v1/hubs/{hub}/connections/{connectionId}` |
| [Broadcast a message to all clients within the target group.](./swagger/v1.md#post-broadcast-a-message-to-all-clients-within-the-target-group.) | `POST /api/v1/hubs/{hub}/groups/{group}` |
| [Check if there are any client connections inside the given group](./swagger/v1.md#get-check-if-there-are-any-client-connections-inside-the-given-group) | `GET /api/v1/hubs/{hub}/groups/{group}` |
| [Check if there are any client connections connected for the given user](./swagger/v1.md#get-check-if-there-are-any-client-connections-connected-for-the-given-user) | `GET /api/v1/hubs/{hub}/users/{user}` |
| [Add a connection to the target group.](./swagger/v1.md#put-add-a-connection-to-the-target-group.) | `PUT /api/v1/hubs/{hub}/groups/{group}/connections/{connectionId}` |
| [Remove a connection from the target group.](./swagger/v1.md#delete-remove-a-connection-from-the-target-group.) | `DELETE /api/v1/hubs/{hub}/groups/{group}/connections/{connectionId}` |
| [Check whether a user exists in the target group.](./swagger/v1.md#get-check-whether-a-user-exists-in-the-target-group.) | `GET /api/v1/hubs/{hub}/groups/{group}/users/{user}` |
| [Add a user to the target group.](./swagger/v1.md#put-add-a-user-to-the-target-group.) | `PUT /api/v1/hubs/{hub}/groups/{group}/users/{user}` |
| [Remove a user from the target group.](./swagger/v1.md#delete-remove-a-user-from-the-target-group.) | `DELETE /api/v1/hubs/{hub}/groups/{group}/users/{user}` |
| [Remove a user from all groups.](./swagger/v1.md#delete-remove-a-user-from-all-groups.) | `DELETE /api/v1/hubs/{hub}/users/{user}/groups` |

## Using REST API

### Authenticate via Azure SignalR Service AccessKey

In each HTTP request, an authorization header with a [JSON Web Token (JWT)](https://en.wikipedia.org/wiki/JSON_Web_Token) is required to authenticate with Azure SignalR Service.

<a name="signing"></a>
#### Signing Algorithm and Signature

`HS256`, namely HMAC-SHA256, is used as the signing algorithm.

You should use the `AccessKey` in Azure SignalR Service instance's connection string to sign the generated JWT token.

#### Claims

Below claims are required to be included in the JWT token.

Claim Type | Is Required | Description
---|---|---
`aud` | true | Should be the **SAME** as your HTTP request url, trailing slash and query parameters not included. For example, a broadcast request's audience should look like: `https://example.service.signalr.net/api/v1/hubs/myhub`.
`exp` | true | Epoch time when this token will be expired.

### Authenticate via Azure Active Directory Token (AAD Token)

Like using `AccessKey`, a [JSON Web Token (JWT)](https://en.wikipedia.org/wiki/JSON_Web_Token) is also required to authenticate the HTTP request.

**The difference is**, in this scenario, JWT Token is generated by Azure Active Directory.

[Learn how to generate AAD Tokens](https://docs.microsoft.com/en-us/azure/active-directory/develop/reference-v2-libraries)

You could also leverage from **Role Based Access Control (RBAC)** to authorize the request from your client/server to Azure SignalR Service.

[Learn how to configure RBAC roles for your resource](https://docs.microsoft.com/en-us/azure/azure-signalr/authorize-access-azure-active-directory)

### Implement Negotiate Endpoint

As shown in the [architecture section](#serverless), you should implement a `negotiate` function that returns a redirect negotiation response so that client can connect to the service.
A typical negotiation response looks like as following:

```json
{
"url":"https://<service_name>.service.signalr.net/client/?hub=<hub_name>",
"accessToken":"<a typical JWT token>"
}
```

The `accessToken` is generated using the same algorithm described in [authentication section](#authentication). The only difference is the `aud` claim should be same as `url`.

You should host your negotiate API in `https://<hub_url>/negotiate` so you can still use SignalR client to connect to the hub url.

Read more about redirecting client to Azure SignalR Service at [here](./internal.md#client-connections).

<a name="user-api"></a>

### User-related REST API

In order to call user-related REST API, each of your clients should identify itself to Azure SignalR Service.
Otherwise SignalR Service can't find target connections from a given user id.

This can be achieved by including a `nameid` claim in each client's JWT token when they are connecting to Azure SignalR Service.
Then SignalR Service will use the value of `nameid` claim as the user id of each client connection.

### Sample

You can find a complete console app to demonstrate how to manually build REST API HTTP request in Azure SignalR Service [here](https://github.com/aspnet/AzureSignalR-samples/tree/master/samples/Serverless).

You can also use [Microsoft.Azure.SignalR.Management](<https://www.nuget.org/packages/Microsoft.Azure.SignalR.Management>) to publish messages to Azure SignalR Service using the similar interfaces of `IHubContext`. Samples can be found [here](<https://github.com/aspnet/AzureSignalR-samples/tree/master/samples/Management>). For more information, see [here](management-sdk-guide.md).


## Limitation

Currently, we have following limitation for REST API request:

* Header size, we only support up to 16KB.
* Body size, we only support up to 1MB.

If you want to send message than 1MB, please use management SDK with persistent connection.
This article has been moved to [here](https://docs.microsoft.com/azure/azure-signalr/signalr-reference-data-plane-rest-api).
131 changes: 1 addition & 130 deletions docs/swagger/v1-preview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,132 +1,3 @@
# Azure SignalR Service REST API
## Version: v1-preview

### Available APIs

| API | Path |
| ---- | ---------- |
| [post /api/v1-preview/hub/{hub}/user/{id}](#post-post-api-v1-preview-hub-hub-user-id) | `POST /api/v1-preview/hub/{hub}/user/{id}` |
| [post /api/v1-preview/hub/{hub}/users/{userList}](#post-post-api-v1-preview-hub-hub-users-userlist) | `POST /api/v1-preview/hub/{hub}/users/{userList}` |
| [post /api/v1-preview/hub/{hub}](#post-post-api-v1-preview-hub-hub) | `POST /api/v1-preview/hub/{hub}` |
| [post /api/v1-preview/hub/{hub}/group/{group}](#post-post-api-v1-preview-hub-hub-group-group) | `POST /api/v1-preview/hub/{hub}/group/{group}` |
| [post /api/v1-preview/hub/{hub}/groups/{groupList}](#post-post-api-v1-preview-hub-hub-groups-grouplist) | `POST /api/v1-preview/hub/{hub}/groups/{groupList}` |
<a name="post-post-api-v1-preview-hub-hub-user-id"></a>
### post /api/v1-preview/hub/{hub}/user/{id}

`POST /api/v1-preview/hub/{hub}/user/{id}`
##### Description:

Send a message to a single user.

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ---- |
| hub | path | Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore. | Yes | string |
| id | path | Target user Id. | Yes | string |
| message | body | | Yes | [Message](#message) |

##### Responses

| Code | Description |
| ---- | ----------- |
| 202 | Accepted |

<a name="post-post-api-v1-preview-hub-hub-users-userlist"></a>
### post /api/v1-preview/hub/{hub}/users/{userList}

`POST /api/v1-preview/hub/{hub}/users/{userList}`
##### Description:

Send a message to multiple users.

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ---- |
| hub | path | Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore. | Yes | string |
| userList | path | Comma-separated list of user Ids. | Yes | string |
| message | body | | Yes | [Message](#message) |

##### Responses

| Code | Description |
| ---- | ----------- |
| 202 | Accepted |

<a name="post-post-api-v1-preview-hub-hub"></a>
### post /api/v1-preview/hub/{hub}

`POST /api/v1-preview/hub/{hub}`
##### Description:

Broadcast a message to all clients connected to target hub.

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ---- |
| hub | path | Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore. | Yes | string |
| message | body | | Yes | [Message](#message) |

##### Responses

| Code | Description |
| ---- | ----------- |
| 202 | Accepted |

<a name="post-post-api-v1-preview-hub-hub-group-group"></a>
### post /api/v1-preview/hub/{hub}/group/{group}

`POST /api/v1-preview/hub/{hub}/group/{group}`
##### Description:

Broadcast a message to all clients within the target group.

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ---- |
| hub | path | Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore. | Yes | string |
| group | path | Target group name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore. | Yes | string |
| message | body | | Yes | [Message](#message) |

##### Responses

| Code | Description |
| ---- | ----------- |
| 202 | Accepted |

<a name="post-post-api-v1-preview-hub-hub-groups-grouplist"></a>
### post /api/v1-preview/hub/{hub}/groups/{groupList}

`POST /api/v1-preview/hub/{hub}/groups/{groupList}`
##### Description:

Broadcast a message to all clients within the target groups.

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ---- |
| hub | path | Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore. | Yes | string |
| groupList | path | Comma-separated list of group names. Each group name should start with alphabetic characters and only contain alpha-numeric characters or underscore. | Yes | string |
| message | body | | Yes | [Message](#message) |

##### Responses

| Code | Description |
| ---- | ----------- |
| 202 | Accepted |

### Models


#### Message

Method invocation message.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| target | string | Target method name. | No |
| arguments | [ object ] | Target method arguments. | No |
This article has been moved to [here](https://docs.microsoft.com/azure/azure-signalr/swagger/signalr-data-plane-rest-v1-preview)
Loading