다음을 통해 공유

Web Pub Sub - Send To Group

  • 참조
서비스:
Azure Web PubSub Service
API 버전:
2024-01-01

요청 본문 내의 콘텐츠를 연결 그룹으로 보냅니다.

POST {endpoint}/api/hubs/{hub}/groups/{group}/:send?api-version=2024-01-01
선택적 매개 변수: 
POST {endpoint}/api/hubs/{hub}/groups/{group}/:send?excluded={excluded}&api-version=2024-01-01&filter={filter}&messageTtlSeconds={messageTtlSeconds}

URI 매개 변수

Name In(다음 안에) 필수 형식 Description
endpoint
 path True

string

url

Web PubSub 서비스 인스턴스에 대한 HTTP 또는 HTTPS 엔드포인트입니다.
group
 path True

string

대상 그룹 이름입니다. 길이는 0보다 크고 1025보다 작아야 합니다.

regex 패턴: ^(?!\s+$).+$
hub
 path True

string

대상 허브 이름- 알파벳 문자로 시작하고 영숫자 또는 밑줄만 포함해야 합니다.

regex 패턴: ^[A-Za-z][A-Za-z0-9_`,.[\]]{0,127}$
api-version
 query True

string

REST API의 버전입니다.
excluded
 query

string[]

제외된 연결 ID
filter
 query

string

OData 필터 구문에 따라 메시지를 받는 구독자를 필터링합니다.
messageTtlSeconds
 query

integer

int32

서비스로 전송된 메시지의 TTL(Time-to-Live) 값(초)입니다. 0은 기본값으로, 메시지가 만료되지 않음을 의미합니다. 최대값은 300입니다. 이 매개 변수가 0이 아닌 경우 지정된 TTL 내에서 클라이언트가 사용하지 않는 메시지는 서비스에서 삭제됩니다. 이 매개 변수는 클라이언트의 대역폭이 제한된 경우에 도움이 될 수 있습니다.

요청 본문

Media Types: "application/octet-stream", "text/plain", "application/json"

Name 형식 Description
message

string

페이로드 본문입니다.

응답

Name 형식 Description
202 Accepted

허용
Other Status Codes

ErrorDetail

오류 응답

헤더

x-ms-error-code: string

예제

WebPubSub_SendToGroup

샘플 요청

POST {endpoint}/api/hubs/hub1/groups/group1/:send?api-version=2024-01-01&filter=startswith(userId, 'listener-')&messageTtlSeconds=15

"Message to send"

샘플 응답

상태 코드:
202

정의

Name Description
ErrorDetail

오류 개체입니다.
InnerError

ErrorDetail

오류 개체입니다.

Name 형식 Description
code

string

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

ErrorDetail[]

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

InnerError

message

string

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

string

오류의 대상입니다.

InnerError

Name 형식 Description
code

string

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

InnerError