Send To Connection - Send To Connection

서비스:

Azure Web PubSub Service

API 버전:

2024-12-01

요청 본문 내부의 콘텐츠를 특정 연결로 보냅니다.

POST {endpoint}/api/hubs/{hub}/connections/{connectionId}/:send?api-version=2024-12-01

선택적 매개 변수:

POST {endpoint}/api/hubs/{hub}/connections/{connectionId}/:send?api-version=2024-12-01&messageTtlSeconds={messageTtlSeconds}

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
connectionId	path	True	string minLength: 1	연결 ID입니다.
endpoint	path	True	string (uri)	Web PubSub 서비스 인스턴스에 대한 HTTP 또는 HTTPS 엔드포인트
hub	path	True	string pattern: ^[A-Za-z][A-Za-z0-9_`,.[\]]{0,127}$	대상 허브 이름은 알파벳 문자로 시작해야 하며 영숫자 또는 밑줄만 포함해야 합니다.
api-version	query	True	string minLength: 1	이 작업에 사용할 API 버전입니다.
messageTtlSeconds	query		integer (int32) minimum: 0 maximum: 300	서비스로 전송된 메시지의 TTL(Time-to-Live) 값(초)입니다. 0은 기본값으로, 메시지가 만료되지 않음을 의미합니다. 300이 최대값입니다. 이 매개 변수가 0이 아닌 경우 지정된 TTL 내에서 클라이언트에서 사용하지 않는 메시지는 서비스에 의해 삭제됩니다. 이 매개변수는 클라이언트의 대역폭이 제한될 때 도움이 될 수 있습니다.

요청 본문

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

Name	형식	Description
message	string (byte)	페이로드 본문입니다.

응답

Name	형식	Description
202 Accepted		처리를 위해 요청이 수락되었지만 처리가 아직 완료되지 않았습니다.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	예기치 않은 오류 응답입니다. 헤더 x-ms-error-code: string

보안

OAuth2Auth

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name	Description
https://webpubsub.azure.com/.default

예제

SendToConnection

샘플 요청

HTTP

POST {endpoint}/api/hubs/hub1/connections/connection1/:send?api-version=2024-12-01&messageTtlSeconds=15

"TWVzc2FnZSB0byBzZW5k"

샘플 응답

상태 코드:

202

정의

Name	Description
Azure.Core.Foundations.Error	오류 개체입니다.
Azure.Core.Foundations.ErrorResponse	오류 세부 정보가 포함된 응답입니다.
Azure.Core.Foundations.InnerError	오류에 대한 보다 구체적인 정보를 포함하는 개체입니다. Azure REST API 가이드라인에 따르면 - https://aka.ms/AzureRestApiGuidelines#handling-errors.

Azure.Core.Foundations.Error

Object

오류 개체입니다.

Name	형식	Description
code	string	서버에서 정의한 오류 코드 집합 중 하나입니다.
details	Azure.Core.Foundations.Error[]	이 보고된 오류로 이어진 특정 오류에 대한 세부 정보 배열입니다.
innererror	Azure.Core.Foundations.InnerError	오류에 대한 현재 개체보다 더 구체적인 정보를 포함하는 개체입니다.
message	string	사람이 읽을 수 있는 오류 표현입니다.
target	string	오류의 대상입니다.

Azure.Core.Foundations.ErrorResponse

Object

오류 세부 정보가 포함된 응답입니다.

Name	형식	Description
error	Azure.Core.Foundations.Error	오류 개체입니다.

Azure.Core.Foundations.InnerError

Object

오류에 대한 보다 구체적인 정보를 포함하는 개체입니다. Azure REST API 가이드라인에 따르면 - https://aka.ms/AzureRestApiGuidelines#handling-errors.

Name	형식	Description
code	string	서버에서 정의한 오류 코드 집합 중 하나입니다.
innererror	Azure.Core.Foundations.InnerError	내부 오류.