다음을 통해 공유


Web Pub Sub - Close User Connections

특정 사용자에 대한 연결을 닫습니다.

POST {endpoint}/api/hubs/{hub}/users/{userId}/:closeConnections?api-version=2024-01-01
POST {endpoint}/api/hubs/{hub}/users/{userId}/:closeConnections?excluded={excluded}&reason={reason}&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}$

userId
path True

string

사용자 ID입니다.

api-version
query True

string

REST API의 버전입니다.

excluded
query

string[]

사용자에 대한 연결을 닫을 때 이러한 connectionIds를 제외합니다.

reason
query

string

클라이언트 연결을 닫는 이유입니다.

응답

Name 형식 Description
204 No Content

콘텐츠 없음

Other Status Codes

ErrorDetail

오류 응답

헤더

x-ms-error-code: string

예제

WebPubSub_CloseUserConnections

샘플 요청

POST {endpoint}/api/hubs/hub1/users/user1/:closeConnections?reason=Close reason&api-version=2024-01-01

샘플 응답

정의

Name Description
ErrorDetail

오류 개체입니다.

InnerError

ErrorDetail

오류 개체입니다.

Name 형식 Description
code

string

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

details

ErrorDetail[]

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

inner

InnerError

message

string

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

target

string

오류의 대상입니다.

InnerError

Name 형식 Description
code

string

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

inner

InnerError