다음을 통해 공유

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 매개 변수

Name In(다음 안에) 필수 형식 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의 버전입니다.

요청 본문

Name 형식 Description
filter

string

대상 연결이 충족하는 OData 필터
groups

string[]

대상 연결이 제거될 그룹 목록

응답

Name 형식 Description
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

정의

Name Description
ErrorDetail

오류 개체입니다.
InnerError
RemoveFromGroupsRequest

대상 그룹 및 연결 필터를 포함하는 요청 개체

ErrorDetail

오류 개체입니다.

Name 형식 Description
code

string

서버에서 정의한 오류 코드 집합 중 하나입니다.
details

ErrorDetail[]

이 보고된 오류로 이어진 특정 오류에 대한 세부 정보 배열입니다.
inner

InnerError

message

string

사람이 읽을 수 있는 오류 표현입니다.
target

string

오류의 대상입니다.

InnerError

Name 형식 Description
code

string

포함된 오류에서 제공한 것보다 더 구체적인 오류 코드입니다.
inner

InnerError

RemoveFromGroupsRequest

대상 그룹 및 연결 필터를 포함하는 요청 개체

Name 형식 Description
filter

string

대상 연결이 충족하는 OData 필터
groups

string[]

대상 연결이 제거될 그룹 목록