通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Web Pub Sub - Remove Connections From Groups

服务:
Azure Web PubSub Service
API 版本:
2024-01-01

从多个组中删除筛选的连接。

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

URI 参数

名称 在 必需 类型 说明
endpoint
 path True

string (url)

Web PubSub 服务实例的 HTTP 或 HTTPS 终结点。
hub
 path True

string

pattern: ^[A-Za-z][A-Za-z0-9_`,.[\]]{0,127}$

目标中心名称，该名称应以字母字符开头，并且仅包含字母数字字符或下划线。
api-version
 query True

string

REST API 的版本。

请求正文

名称 类型 说明
filter

string

目标连接满足的 OData 筛选器
groups

string[]

将从中删除目标连接的组列表

响应

名称 类型 说明
200 OK

成功
Other Status Codes

ErrorDetail

错误响应

标头

x-ms-error-code: string

示例

WebPubSub_RemoveConnectionsFromGroups

示例请求

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

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

示例响应

状态代码:
200

定义

名称 说明
ErrorDetail

错误对象。
InnerError
RemoveFromGroupsRequest

包含目标组和连接筛选器的请求对象

ErrorDetail

Object

错误对象。

名称 类型 说明
code

string

服务器定义的错误代码集之一。
details

ErrorDetail[]

导致此报告错误的特定错误的详细信息数组。
inner

InnerError

message

string

错误的人工可读表示形式。
target

string

错误的目标。

InnerError

Object
名称 类型 说明
code

string

比包含的错误提供的错误代码更具体。
inner

InnerError

RemoveFromGroupsRequest

Object

包含目标组和连接筛选器的请求对象

名称 类型 说明
filter

string

目标连接满足的 OData 筛选器
groups

string[]

将从中删除目标连接的组列表