Azure SignalR 服务数据平面 REST API - 2024-12-01

版本：2024-12-01

可用 API

API 路径
获取 /api/auth/accessKey GET /api/auth/accessKey
获取服役健康状态。 HEAD /api/health
关闭集线器里的所有连接。 POST /api/hubs/{hub}/:closeConnections
在交易中执行所有连接的命令。 POST /api/hubs/{hub}/:execute
为客户端生成令牌以连接SignalR服务Azure. POST /api/hubs/{hub}/:generateToken
向所有连接到目标枢纽的客户端广播消息。 POST /api/hubs/{hub}/:send
关闭客户端连接 DELETE /api/hubs/{hub}/connections/{connectionId}
检查带有该连接ID的连接是否存在 HEAD /api/hubs/{hub}/connections/{connectionId}
在连接上调用一种方法。 POST /api/hubs/{hub}/connections/{connectionId}/:invoke
向具体的连接发送消息。 POST /api/hubs/{hub}/connections/{connectionId}/:send
从所有组中移除连接 DELETE /api/hubs/{hub}/connections/{connectionId}/groups
完成针对特定连接的流媒体播放。 POST /api/hubs/{hub}/connections/{connectionId}/streams/{streamId}/:complete
向该连接的特定流发送流消息。 POST /api/hubs/{hub}/connections/{connectionId}/streams/{streamId}/:send
检查该组内是否有客户端连接 HEAD /api/hubs/{hub}/groups/{group}
在特定群体中建立紧密关系。 POST /api/hubs/{hub}/groups/{group}/:closeConnections
向目标组内的所有客户端广播消息。 POST /api/hubs/{hub}/groups/{group}/:send
在群体中列出联系。 GET /api/hubs/{hub}/groups/{group}/connections
从目标群体中移除连接。 DELETE /api/hubs/{hub}/groups/{group}/connections/{connectionId}
为目标群体添加连接。 PUT /api/hubs/{hub}/groups/{group}/connections/{connectionId}
检查该用户是否有连接的客户端连接 HEAD /api/hubs/{hub}/users/{user}
为特定用户建立紧密连接。 POST /api/hubs/{hub}/users/{user}/:closeConnections
向所有属于目标用户的客户端广播消息。 POST /api/hubs/{hub}/users/{user}/:send
从所有组中移除一名用户。 DELETE /api/hubs/{hub}/users/{user}/groups
将目标群体中的一名用户移除。 DELETE /api/hubs/{hub}/users/{user}/groups/{group}
检查目标群体中是否存在用户。 HEAD /api/hubs/{hub}/users/{user}/groups/{group}
添加一个用户到目标群体。 PUT /api/hubs/{hub}/users/{user}/groups/{group}

/api/auth/accessKey

GET

获取 /api/auth/accessKey

GET /api/auth/accessKey

参数
Name 位于 Description 必需 架构
api-version 查询 REST API 的版本。 Yes 字符串
Responses
Code Description 架构
200 好的 访问密钥响应
默认 错误响应

/api/health

摘要

获取服务运行状况。

获取服役健康状态

HEAD /api/health

参数
Name 位于 Description 必需 架构
api-version 查询 REST API 的版本。 Yes 字符串
Responses
Code Description
200 服务健康
默认 错误响应

/api/hubs/{hub}/：closeConnections

POST

摘要

关闭集线器里的所有连接。

关闭集线器中的所有连接

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

参数
Name 位于 Description 必需 架构
中心 路径 目标中心名称，应以字母字符开头，仅包含字母数字字符或下划线。 Yes 字符串
应用程序 查询 目标应用程序名称，应以字母字符开头，仅包含字母数字字符或下划线。 No 字符串
排除 查询 关闭集线器连接时，排除这些连接ID。 No [弦声]
原因 查询 关闭客户连接的原因。 No 字符串
api-version 查询 REST API 的版本。 Yes 字符串
Responses
Code Description 架构
204 无内容
默认 错误响应 ErrorDetail

/api/hubs/{hub}/：execute

POST

摘要

在交易中执行所有连接的命令。

在事务中执行所有连接的命令

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

参数
Name 位于 Description 必需 架构
中心 路径 目标中心名称，应以字母字符开头，仅包含字母数字字符或下划线。 Yes 字符串
筛选器 查询 按照OData滤波器语法过滤用户。 No 字符串
api-version 查询 REST API 的版本。 Yes 字符串
commands body 在事务中执行命令。 Yes [ 信号 ]
Responses
Code Description 架构
202 已接受
默认 错误响应 ErrorDetail

/api/hubs/{hub}/：generateToken

POST

摘要

为客户端生成令牌以连接 Azure SignalR 服务。

为客户端生成令牌以连接 Azure SignalR 服务

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

参数
Name 位于 Description 必需 架构
中心 路径 目标中心名称，应以字母字符开头，仅包含字母数字字符或下划线。 Yes 字符串
userId 查询 用户 ID。 No 字符串
几分钟将过期 查询 生成的令牌的过期时间。 No 整数
api-version 查询 REST API 的版本。 Yes 字符串
Responses
Code Description 架构
200 好的 ClientTokenResponse
默认 错误响应 ErrorDetail

/api/hubs/{hub}/：send

POST

摘要

向所有连接到目标枢纽的客户端广播消息。

向所有连接到目标集线器的客户端广播消息

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

参数
Name 位于 Description 必需 架构
中心 路径 目标中心名称，应以字母字符开头，仅包含字母数字字符或下划线。 Yes 字符串
应用程序 查询 目标应用程序名称，应以字母字符开头，仅包含字母数字字符或下划线。 No 字符串
排除 查询 排除的连接ID No [弦声]
api-version 查询 REST API 的版本。 Yes 字符串
有效负载 body 有效载荷信息。 Yes 有效载荷消息
Responses
Code Description 架构
202 已接受 服务响应
默认 错误响应 ErrorDetail

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

DELETE

摘要

关闭客户端连接

关闭客户端连接

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

参数
Name 位于 Description 必需 架构
中心 路径 目标中心名称，应以字母字符开头，仅包含字母数字字符或下划线。 Yes 字符串
connectionId 路径 连接 ID。 Yes 字符串
应用程序 查询 目标应用程序名称，应以字母字符开头，仅包含字母数字字符或下划线。 No 字符串
原因 查询 连接关闭的原因。 No 字符串
api-version 查询 REST API 的版本。 Yes 字符串
Responses
Code Description 架构
200 好的 服务响应
默认 错误响应 ErrorDetail

标题

摘要

检查带有该连接ID的连接是否存在

检查带有该连接ID的连接是否存在

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

参数
Name 位于 Description 必需 架构
中心 路径 目标中心名称，应以字母字符开头，仅包含字母数字字符或下划线。 Yes 字符串
connectionId 路径 连接 ID。 Yes 字符串
应用程序 查询 目标应用程序名称，应以字母字符开头，仅包含字母数字字符或下划线。 No 字符串
api-version 查询 REST API 的版本。 Yes 字符串
Responses
Code Description
200 好的
默认 错误响应

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

POST

摘要

在连接上调用一种方法。

调用连接上的方法

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

参数
Name 位于 Description 必需 架构
中心 路径 目标中心名称，应以字母字符开头，仅包含字母数字字符或下划线。 Yes 字符串
connectionId 路径 目标中心名称，应以字母字符开头，仅包含字母数字字符或下划线。 Yes 字符串
应用程序 查询 目标应用程序名称，应以字母字符开头，仅包含字母数字字符或下划线。 No 字符串
api-version 查询 REST API 的版本。 Yes 字符串
有效负载 body 有效载荷信息。 Yes 有效载荷消息
Responses
Code Description 架构
200 好的 客户端调用响应
默认 错误响应 ErrorDetail

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

POST

摘要

向具体的连接发送消息。

向特定连接发送消息

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

参数
Name 位于 Description 必需 架构
中心 路径 目标中心名称，应以字母字符开头，仅包含字母数字字符或下划线。 Yes 字符串
connectionId 路径 连接 ID。 Yes 字符串
应用程序 查询 目标应用程序名称，应以字母字符开头，仅包含字母数字字符或下划线。 No 字符串
api-version 查询 REST API 的版本。 Yes 字符串
有效负载 body 有效载荷信息。 Yes 有效载荷消息
Responses
Code Description 架构
202 已接受 服务响应
默认 错误响应 ErrorDetail

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

DELETE

摘要

从所有组中移除连接

从所有组中移除连接

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

参数
Name 位于 Description 必需 架构
中心 路径 目标中心名称，应以字母字符开头，仅包含字母数字字符或下划线。 Yes 字符串
connectionId 路径 目标连接ID Yes 字符串
应用程序 查询 目标应用程序名称，应以字母字符开头，仅包含字母数字字符或下划线。 No 字符串
api-version 查询 REST API 的版本。 Yes 字符串
Responses
Code Description 架构
200 好的 服务响应
默认 错误响应 ErrorDetail

/api/hubs/{hub}/connections/{connectionId}/streams/{streamId}/：complete

POST

摘要

完成针对特定连接的流媒体播放。

完成该连接的流媒体播放

POST /api/hubs/{hub}/connections/{connectionId}/streams/{streamId}/:complete

参数
Name 位于 Description 必需 架构
中心 路径 目标中心名称，应以字母字符开头，仅包含字母数字字符或下划线。 Yes 字符串
connectionId 路径 连接 ID。 Yes 字符串
streamId 路径 流 ID。 Yes 字符串
原因 查询 完成时出现错误。 No 字符串
应用程序 查询 目标应用程序名称，应以字母字符开头，仅包含字母数字字符或下划线。 No 字符串
api-version 查询 REST API 的版本。 Yes 字符串
Responses
Code Description 架构
202 已接受 服务响应
默认 错误响应 ErrorDetail

/api/hubs/{hub}/connections/{connectionId}/streams/{streamId}/：send

POST

摘要

向该连接的特定流发送流消息。

向该连接的特定流发送流消息

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

参数
Name 位于 Description 必需 架构
中心 路径 目标中心名称，应以字母字符开头，仅包含字母数字字符或下划线。 Yes 字符串
connectionId 路径 连接 ID。 Yes 字符串
streamId 路径 流 ID。 Yes 字符串
应用程序 查询 目标应用程序名称，应以字母字符开头，仅包含字母数字字符或下划线。 No 字符串
完成 查询 当前标注项目是该流的最后一项。 No boolean
api-version 查询 REST API 的版本。 Yes 字符串
Responses
Code Description 架构
202 已接受 服务响应
默认 错误响应 ErrorDetail

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

标题

摘要

检查给定组内是否有任何客户端连接

检查给定组内是否有任何客户端连接

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

参数
Name 位于 Description 必需 架构
中心 路径 目标中心名称，应以字母字符开头，仅包含字母数字字符或下划线。 Yes 字符串
组 路径 目标组名称，长度应大于 0 且小于 1025。 Yes 字符串
应用程序 查询 目标应用程序名称，应以字母字符开头，仅包含字母数字字符或下划线。 No 字符串
api-version 查询 REST API 的版本。 Yes 字符串
Responses
Code Description
200 好的
404 未找到
默认 错误响应

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

POST

摘要

关闭特定组中的连接。

特定群体中的密切联系

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

参数
Name 位于 Description 必需 架构
中心 路径 目标中心名称，应以字母字符开头，仅包含字母数字字符或下划线。 Yes 字符串
组 路径 目标组名称，长度应大于 0 且小于 1025。 Yes 字符串
应用程序 查询 目标应用程序名称，应以字母字符开头，仅包含字母数字字符或下划线。 No 字符串
排除 查询 关闭集线器连接时，排除这些连接ID。 No [弦声]
原因 查询 关闭客户连接的原因。 No 字符串
api-version 查询 REST API 的版本。 Yes 字符串
Responses
Code Description 架构
204 无内容
默认 错误响应 ErrorDetail

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

POST

摘要

向目标组内的所有客户端广播消息。

向目标组内的所有客户端广播消息

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

参数
Name 位于 Description 必需 架构
中心 路径 目标中心名称，应以字母字符开头，仅包含字母数字字符或下划线。 Yes 字符串
组 路径 目标组名称，长度应大于 0 且小于 1025。 Yes 字符串
应用程序 查询 目标应用程序名称，应以字母字符开头，仅包含字母数字字符或下划线。 No 字符串
排除 查询 排除的连接ID No [弦声]
api-version 查询 REST API 的版本。 Yes 字符串
有效负载 body 有效载荷信息。 Yes 有效载荷消息
Responses
Code Description 架构
202 已接受 服务响应
默认 错误响应 ErrorDetail

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

GET

摘要

列出组中的连接。

在群中列出连接

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

参数
Name 位于 Description 必需 架构
中心 路径 目标中心名称，应以字母字符开头，仅包含字母数字字符或下划线。 Yes 字符串
组 路径 目标组名称，其长度应大于 0 且小于 1025。 Yes 字符串
maxpagesize 查询 单个响应中要包含的最大连接数。 它应该在 1 到 200 之间。 No 整数
top 查询 要返回的最大连接数。 如果未设置该值，则返回组中的所有连接。 No 整数
应用程序 查询 目标应用程序名称，应以字母字符开头，仅包含字母数字字符或下划线。 No 字符串
continuationToken 查询 允许客户端检索下一页结果的令牌。 当有其他结果要获取时，服务在响应上一个请求时提供此参数。 客户端应在下一个请求中包含 continuationToken，以接收后续数据页面。 如果省略此参数，服务器将返回结果的第一页。 No 字符串
api-version 查询 REST API 的版本。 Yes 字符串
Responses
Code Description 架构
200 好的 组成员分页值
默认 错误响应 ErrorDetail

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

DELETE

摘要

从目标组中删除连接。

从目标组中移除连接

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

参数
Name 位于 Description 必需 架构
中心 路径 目标中心名称，应以字母字符开头，仅包含字母数字字符或下划线。 Yes 字符串
组 路径 目标组名称，长度应大于 0 且小于 1025。 Yes 字符串
connectionId 路径 目标连接ID Yes 字符串
应用程序 查询 目标应用程序名称，应以字母字符开头，仅包含字母数字字符或下划线。 No 字符串
api-version 查询 REST API 的版本。 Yes 字符串
Responses
Code Description 架构
200 好的 服务响应
默认 错误响应 ErrorDetail

PUT

摘要

添加与目标组的连接。

添加与目标群体的联系

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

参数
Name 位于 Description 必需 架构
中心 路径 目标中心名称，应以字母字符开头，仅包含字母数字字符或下划线。 Yes 字符串
组 路径 目标组名称，长度应大于 0 且小于 1025。 Yes 字符串
connectionId 路径 目标连接ID Yes 字符串
应用程序 查询 目标应用程序名称，应以字母字符开头，仅包含字母数字字符或下划线。 No 字符串
api-version 查询 REST API 的版本。 Yes 字符串
Responses
Code Description 架构
200 好的 服务响应
404 未找到
默认 错误响应 ErrorDetail

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

标题

摘要

检查该用户是否有连接的客户端连接

检查该用户是否有连接的客户端连接

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

参数
Name 位于 Description 必需 架构
中心 路径 目标中心名称，应以字母字符开头，仅包含字母数字字符或下划线。 Yes 字符串
用户 路径 用户 ID。 Yes 字符串
应用程序 查询 目标应用程序名称，应以字母字符开头，仅包含字母数字字符或下划线。 No 字符串
api-version 查询 REST API 的版本。 Yes 字符串
Responses
Code Description
200 好的
404 未找到
默认 错误响应

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

POST

摘要

关闭特定用户的连接。

针对特定用户的紧密连接

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

参数
Name 位于 Description 必需 架构
中心 路径 目标中心名称，应以字母字符开头，仅包含字母数字字符或下划线。 Yes 字符串
用户 路径 用户 ID。 Yes 字符串
应用程序 查询 目标应用程序名称，应以字母字符开头，仅包含字母数字字符或下划线。 No 字符串
排除 查询 关闭集线器连接时，排除这些连接ID。 No [弦声]
原因 查询 关闭客户连接的原因。 No 字符串
api-version 查询 REST API 的版本。 Yes 字符串
Responses
Code Description 架构
204 无内容
默认 错误响应 ErrorDetail

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

POST

摘要

向所有属于目标用户的客户端广播消息。

向所有属于目标用户的客户端广播消息

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

参数
Name 位于 Description 必需 架构
中心 路径 目标中心名称，应以字母字符开头，仅包含字母数字字符或下划线。 Yes 字符串
用户 路径 用户 ID。 Yes 字符串
应用程序 查询 目标应用程序名称，应以字母字符开头，仅包含字母数字字符或下划线。 No 字符串
api-version 查询 REST API 的版本。 Yes 字符串
有效负载 body 有效载荷信息。 Yes 有效载荷消息
Responses
Code Description 架构
202 已接受 服务响应
默认 错误响应 ErrorDetail

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

DELETE

摘要

从所有组中删除用户。

从所有组中删除用户

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

参数
Name 位于 Description 必需 架构
中心 路径 目标中心名称，应以字母字符开头，仅包含字母数字字符或下划线。 Yes 字符串
用户 路径 目标用户ID Yes 字符串
应用程序 查询 目标应用程序名称，应以字母字符开头，仅包含字母数字字符或下划线。 No 字符串
api-version 查询 REST API 的版本。 Yes 字符串
Responses
Code Description 架构
204 无内容
默认 错误响应 ErrorDetail

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

DELETE

摘要

从目标组中删除用户。

将用户从目标群体中移除

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

参数
Name 位于 Description 必需 架构
中心 路径 目标中心名称，应以字母字符开头，仅包含字母数字字符或下划线。 Yes 字符串
组 路径 目标组名称，长度应大于 0 且小于 1025。 Yes 字符串
用户 路径 目标用户ID Yes 字符串
应用程序 查询 目标应用程序名称，应以字母字符开头，仅包含字母数字字符或下划线。 No 字符串
api-version 查询 REST API 的版本。 Yes 字符串
Responses
Code Description 架构
204 无内容
默认 错误响应 ErrorDetail

标题

摘要

检查目标群体中是否存在用户。

检查目标群体中是否存在用户

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

参数
Name 位于 Description 必需 架构
中心 路径 目标中心名称，应以字母字符开头，仅包含字母数字字符或下划线。 Yes 字符串
组 路径 目标组名称，长度应大于 0 且小于 1025。 Yes 字符串
用户 路径 目标用户ID Yes 字符串
应用程序 查询 目标应用程序名称，应以字母字符开头，仅包含字母数字字符或下划线。 No 字符串
api-version 查询 REST API 的版本。 Yes 字符串
Responses
Code Description
200 好的
404 未找到
默认 错误响应

PUT

摘要

将用户添加到目标组。

将用户添加到目标群体

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

参数
Name 位于 Description 必需 架构
中心 路径 目标中心名称，应以字母字符开头，仅包含字母数字字符或下划线。 Yes 字符串
组 路径 目标组名称，长度应大于 0 且小于 1025。 Yes 字符串
用户 路径 目标用户ID Yes 字符串
应用程序 查询 目标应用程序名称，应以字母字符开头，仅包含字母数字字符或下划线。 No 字符串
ttl 查询 指定用户在组中存在的秒数。 如果没有设置，用户最多只能在群组中生活一年。 如果用户被添加到某些没有TTL限制的群组，只有最新更新的100个群组会被保留在所有未使用TTL的用户加入的群组中。 如果 ttl = 0，只有目标用户当前连接的连接会被添加到目标组。 No 整数
api-version 查询 REST API 的版本。 Yes 字符串
Responses
Code Description 架构
200 好的 服务响应
默认 错误响应 ErrorDetail

模型

访问密钥响应

响应对象包含用于签署客户端令牌的动态访问密钥。

Name 类型 Description 必需
访问密钥 字符串 SignalR 应用服务器用于签署客户端令牌的访问密钥字符串值。 No
密钥ID 字符串 访问密钥的ID。 No

ByteReadOnlyMemoryIAsyncEnumerable

Name 类型 Description 必需
ByteReadOnlyMemoryIAsyncEnumerable 对象

客户端调用响应

客户端调用 REST API 的响应对象

Name 类型 Description 必需
result 客户端返回的调用结果（可选） No
协议 字符串 客户端使用的协议（可选，如果不能用json或mspack也可以用） No

ClientTokenResponse

包含客户端令牌的响应对象

Name 类型 Description 必需
代币 字符串 WebSocket客户端连接服务的令牌值 No

关闭连接

Name 类型 Description 必需
关闭连接

错误详情

错误对象。

Name 类型 Description 必需
代码 字符串 服务器定义的错误代码集之一。 No
消息 字符串 错误的人工可读表示形式。 No
目标 字符串 错误的目标。 No
details [ 错误详情 ] 导致此报告错误的特定错误的详细信息数组。 No
内 内部错误 No

小组成员

Name 类型 Description 必需
connectionId 字符串 连接的唯一标识符。
例："connection1"		 Yes
userId 字符串 连接的用户 ID。 用户可以拥有多个连接。
例："user1"		 No

组成员分页值

将一页元素表示为 LIST REST API 结果。

Name 类型 Description 必需
value [ 组员 ] Yes
nextLink string （uri） 一个客户端可以获取的绝对URL，以便检索集合的下一页。 No

InnerError

Name 类型 Description 必需
代码 字符串 比包含错误的错误代码更具体。 No
内 内部错误 No

加入集团

Name 类型 Description 必需
加入集团

离开集团

Name 类型 Description 必需
离开集团

有效载荷消息

Name 类型 Description 必需
目标 字符串 Yes
arguments [ ] No

SendMessage

Name 类型 Description 必需
SendMessage

ServiceResponse

Name 类型 Description 必需
状态码 整数 枚举：100， 101， ， 102103200201202203204205206207208226300301302303304305306307308400401402403404405406407408409410411412413414415416417421422423424426428429431451500501502503504505506507508510511 No
代码 字符串 No
水平仪 字符串 枚举："Info"， "Warning""Error" No
作用域 字符串 枚举："Unknown"， "Request"， "Connection"， "User"， "Group" No
错误类型 字符串 枚举："Unknown"， "NotExisted"， "NotInGroup"， "Invalid" No
消息 字符串 No
jsonObject No
是否成功 boolean No
数据流 ByteReadOnlyMemoryIAsyncEnumerable No

信号中心

Name 类型 Description 必需
类型 字符串 枚举："SendMessage"， "JoinGroup"， "LeaveGroup"， "CloseConnection" Yes
  • Last updated on