Web Pub Sub - Add Connections To Groups

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

フィルター処理された接続を複数のグループに追加します。

POST {endpoint}/api/hubs/{hub}/:addToGroups?api-version=2024-01-01

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 のバージョン。

要求本文

名前 型 説明
filter

string

ターゲット接続が満たす OData フィルター
groups

string[]

ターゲット接続が追加されるグループの一覧

応答

名前 型 説明
200 OK

成功
Other Status Codes

ErrorDetail

エラー応答

ヘッダー

x-ms-error-code: string

例

WebPubSub_AddConnectionsToGroups

要求のサンプル

POST {endpoint}/api/hubs/hub1/:addToGroups?api-version=2024-01-01

{
  "groups": [
    "group1",
    "group2"
  ],
  "filter": "startswith(userId, 'listener-')"
}

応答のサンプル

状態コード:
200

定義

名前 説明
AddToGroupsRequest

ターゲット グループと接続フィルターを含む要求オブジェクト
ErrorDetail

エラー オブジェクト。
InnerError

AddToGroupsRequest

ターゲット グループと接続フィルターを含む要求オブジェクト

名前 型 説明
filter

string

ターゲット接続が満たす OData フィルター
groups

string[]

ターゲット接続が追加されるグループの一覧

ErrorDetail

エラー オブジェクト。

名前 型 説明
code

string

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

ErrorDetail[]

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

InnerError

message

string

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

string

エラーのターゲット。

InnerError

名前 型 説明
code

string

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

InnerError