Web Pub Sub - Send To All

  • リファレンス
サービス:
Azure Web PubSub Service
API バージョン:
2024-01-01

接続されているすべてのクライアント接続に要求本文内のコンテンツをブロードキャストします。

POST {endpoint}/api/hubs/{hub}/:send?api-version=2024-01-01
省略可能なパラメーターを含む: 
POST {endpoint}/api/hubs/{hub}/:send?excluded={excluded}&api-version=2024-01-01&filter={filter}&messageTtlSeconds={messageTtlSeconds}

URI パラメーター

名前 / 必須 型 説明
endpoint
 path True

string

url

Web PubSub サービス インスタンスの HTTP または HTTPS エンドポイント。
hub
 path True

string

ターゲット ハブ名。アルファベット文字で始まり、英数字またはアンダースコアのみを含む必要があります。

正規表現パターン: ^[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

サービスに送信されるメッセージの Time to Live (TTL) 値 (秒単位)。 0 は既定値です。つまり、メッセージの有効期限は切れません。 最大値は 300 です。 このパラメーターが 0 以外の場合、指定した TTL 内でクライアントによって使用されないメッセージは、サービスによって削除されます。 このパラメーターは、クライアントの帯域幅が制限されている場合に役立ちます。

要求本文

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

名前 型 説明
message

string

ペイロード本文。

応答

名前 型 説明
202 Accepted

メッセージは受け入れられます。 サービスは、メッセージの送信時にファイア アンド フォーゲット パターンに従います。
Other Status Codes

ErrorDetail

エラー応答

ヘッダー

x-ms-error-code: string

例

WebPubSub_SendToAll

要求のサンプル

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

"Message to send"

応答のサンプル

状態コード:
202

定義

名前 説明
ErrorDetail

エラー オブジェクト。
InnerError

ErrorDetail

エラー オブジェクト。

名前 型 説明
code

string

サーバー定義の一連のエラー コードの 1 つ。
details

ErrorDetail[]

この報告されたエラーの原因となった特定のエラーに関する詳細の配列。
inner

InnerError

message

string

エラーの人間が判読できる表現。
target

string

エラーのターゲット。

InnerError

名前 型 説明
code

string

含まれているエラーによって提供されたよりも具体的なエラー コード。
inner

InnerError