Web Pub Sub - Add Connections To Groups

服務:

Azure Web PubSub Service

API 版本:

2024-01-01

將篩選的連線新增至多個群組。

POST {endpoint}/api/hubs/{hub}/:addToGroups?api-version=2024-01-01

URI 參數

名稱	位於	必要	類型	Description
endpoint	path	True	string url	Web PubSub 服務實例的 HTTP 或 HTTPS 端點。
hub	path	True	string	目標中樞名稱，其開頭應為字母字元，且只包含英數位元或底線。 Regex 模式: ^[A-Za-z][A-Za-z0-9_`,.[\]]{0,127}$
api-version	query	True	string	REST API 的版本。

要求本文

名稱	類型	Description
filter	string	目標連線滿足的 OData 篩選條件
groups	string[]	將新增目標連線的群組清單

回應

名稱	類型	Description
200 OK		成功
Other Status Codes	ErrorDetail	錯誤回應 標題 x-ms-error-code: string

範例

WebPubSub_AddConnectionsToGroups

範例要求

HTTP

POST {endpoint}/api/hubs/hub1/:addToGroups?api-version=2024-01-01

{
  "groups": [
    "group1",
    "group2"
  ],
  "filter": "startswith(userId, 'listener-')"
}

範例回覆

狀態碼:

200

定義

名稱	Description
AddToGroupsRequest	包含目標群組和連接篩選的要求物件
ErrorDetail	error 物件。
InnerError

AddToGroupsRequest

包含目標群組和連接篩選的要求物件

名稱	類型	Description
filter	string	目標連線滿足的 OData 篩選條件
groups	string[]	將新增目標連線的群組清單

ErrorDetail

error 物件。

名稱	類型	Description
code	string	其中一組伺服器定義的錯誤碼。
details	ErrorDetail[]	導致此錯誤之特定錯誤的詳細數據陣列。
inner	InnerError
message	string	錯誤的人類可讀取表示法。
target	string	錯誤的目標。

InnerError

名稱	類型	Description
code	string	比包含的錯誤所提供更明確的錯誤碼。
inner	InnerError