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 パラメーター

名前	/	必須	型	説明
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) 値 (秒単位)。 0 はデフォルト値で、メッセージの有効期限が切れることはありません。 300が最大値です。 このパラメーターが 0 以外の場合、指定された TTL 内でクライアントによって消費されないメッセージは、サービスによってドロップされます。 このパラメーターは、クライアントの帯域幅が制限されている場合に役立ちます。

要求本文

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

名前	型	説明
message	string (byte)	ペイロード本体。

応答

名前	型	説明
202 Accepted		要求は処理のために受け入れ済みですが、処理はまだ完了していません。
Other Status Codes	ErrorDetail	エラー応答。 ヘッダー x-ms-error-code: string

セキュリティ

OAuth2Auth

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
https://webpubsub.azure.com/.default

例

SendToConnection

要求のサンプル

HTTP

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

"TWVzc2FnZSB0byBzZW5k"

応答のサンプル

状態コード:

202

定義

名前	説明
ErrorDetail	エラー オブジェクト。
InnerError	内部エラーの詳細。

ErrorDetail

Object

エラー オブジェクト。

名前	型	説明
code	string	サーバー定義の一連のエラー コードの 1 つ。
details	ErrorDetail[]	この報告されたエラーの原因となった特定のエラーに関する詳細の配列。
inner	InnerError	エラーに関するより具体的な情報を含むオブジェクト。
message	string	エラーの人間が判読できる表現。
target	string	エラーのターゲット。

InnerError

Object

内部エラーの詳細。

名前	型	説明
code	string	含まれているエラーよりも、より具体的なエラーコードです。
inner	InnerError	内部エラー。