Add Connection To Group - Add Connection To Group

服务:

Azure Web PubSub Service

API 版本:

2024-12-01

添加与目标组的连接。

PUT {endpoint}/api/hubs/{hub}/groups/{group}/connections/{connectionId}?api-version=2024-12-01

URI 参数

名称	在	必需	类型	说明
connectionId	path	True	string minLength: 1	目标连接 ID
endpoint	path	True	string (uri)	Web PubSub 服务实例的 HTTP 或 HTTPS 终结点
group	path	True	string minLength: 1 maxLength: 1024 pattern: ^(?!\s+$).+$	目标组名称，长度应大于 0 且小于 1025。
hub	path	True	string pattern: ^[A-Za-z][A-Za-z0-9_`,.[\]]{0,127}$	目标中心名称，应以字母字符开头，仅包含字母数字字符或下划线。
api-version	query	True	string minLength: 1	用于此作的 API 版本。

响应

名称	类型	说明
200 OK		请求已成功。
Other Status Codes	Azure.Core.Foundations.ErrorResponse	意外错误响应。 标头 x-ms-error-code: string

安全性

OAuth2Auth

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
https://webpubsub.azure.com/.default

示例

AddConnectionToGroup

示例请求

HTTP

PUT {endpoint}/api/hubs/hub1/groups/group1/connections/connection1?api-version=2024-12-01

示例响应

状态代码:

200

定义

名称	说明
Azure.Core.Foundations.Error	错误对象。
Azure.Core.Foundations.ErrorResponse	包含错误详细信息的响应。
Azure.Core.Foundations.InnerError	包含有关错误的更具体信息的对象。 根据 Azure REST API 准则 - https://aka.ms/AzureRestApiGuidelines#handling-errors。

Azure.Core.Foundations.Error

Object

错误对象。

名称	类型	说明
code	string	服务器定义的一组错误代码之一。
details	Azure.Core.Foundations.Error[]	有关导致此报告错误的特定错误的一系列详细信息。
innererror	Azure.Core.Foundations.InnerError	包含比当前对象更具体的错误信息的对象。
message	string	错误的人类可读表示。
target	string	错误的目标。

Azure.Core.Foundations.ErrorResponse

Object

包含错误详细信息的响应。

名称	类型	说明
error	Azure.Core.Foundations.Error	错误对象。

Azure.Core.Foundations.InnerError

Object

包含有关错误的更具体信息的对象。 根据 Azure REST API 准则 - https://aka.ms/AzureRestApiGuidelines#handling-errors。

名称	类型	说明
code	string	服务器定义的一组错误代码之一。
innererror	Azure.Core.Foundations.InnerError	内部错误。