次の方法で共有

Azure SignalR Service データ プレーン REST API - v1 プレビュー

  • [アーティクル]

この記事には、Azure SignalR Service データ プレーン用の古い v1 プレビュー バージョンの REST API が記載されています。 代わりに最新バージョンをお使いください。

利用可能な API

API パス
post /api/v1-preview/hub/{hub}/user/{id} POST /api/v1-preview/hub/{hub}/user/{id}
post /api/v1-preview/hub/{hub}/users/{userList} POST /api/v1-preview/hub/{hub}/users/{userList}
post /api/v1-preview/hub/{hub} POST /api/v1-preview/hub/{hub}
post /api/v1-preview/hub/{hub}/group/{group} POST /api/v1-preview/hub/{hub}/group/{group}
post /api/v1-preview/hub/{hub}/groups/{groupList} POST /api/v1-preview/hub/{hub}/groups/{groupList}

post /api/v1-preview/hub/{hub}/user/{id}

POST /api/v1-preview/hub/{hub}/user/{id}

説明:

1 人のユーザーにメッセージを送信します。

パラメーター
名前 ロケーション 説明 必須 [スキーマ]
ハブ path ターゲット ハブ名。これは、英文字から始まる必要があり、使用できる文字は英数字とアンダースコアのみです。 はい string
id path ターゲット ユーザー ID。 はい string
message body はい メッセージ
応答
コード 説明
202 Accepted

post /api/v1-preview/hub/{hub}/users/{userList}

POST /api/v1-preview/hub/{hub}/users/{userList}

説明:

複数のユーザーにメッセージを送信します。

パラメーター
名前 ロケーション 説明 必須 [スキーマ]
ハブ path ターゲット ハブ名。これは、英文字から始まる必要があり、使用できる文字は英数字とアンダースコアのみです。 はい string
userList path ユーザー ID のコンマ区切りリストです。 はい string
message body はい メッセージ
応答
コード 説明
202 Accepted

post /api/v1-preview/hub/{hub}

POST /api/v1-preview/hub/{hub}

説明:

ターゲット ハブに接続されているすべてのクライアントにメッセージをブロードキャストします。

パラメーター
名前 ロケーション 説明 必須 [スキーマ]
ハブ path ターゲット ハブ名。これは、英文字から始まる必要があり、使用できる文字は英数字とアンダースコアのみです。 はい string
message body はい メッセージ
応答
コード 説明
202 Accepted

post /api/v1-preview/hub/{hub}/group/{group}

POST /api/v1-preview/hub/{hub}/group/{group}

説明:

ターゲット グループ内のすべてのクライアントにメッセージをブロードキャストします。

パラメーター
名前 ロケーション 説明 必須 [スキーマ]
ハブ path ターゲット ハブ名。これは、英文字から始まる必要があり、使用できる文字は英数字とアンダースコアのみです。 はい string
グループ path ターゲット グループ名。これは、英文字から始まる必要があり、使用できる文字は英数字とアンダースコアのみです。 はい string
message body はい メッセージ
応答
コード 説明
202 Accepted

post /api/v1-preview/hub/{hub}/groups/{groupList}

POST /api/v1-preview/hub/{hub}/groups/{groupList}

説明:

ターゲット グループ内のすべてのクライアントにメッセージをブロードキャストします。

パラメーター
名前 ロケーション 説明 必須 [スキーマ]
ハブ path ターゲット ハブ名。これは、英文字から始まる必要があり、使用できる文字は英数字とアンダースコアのみです。 はい string
groupList path グループ名のコンマ区切りリスト。 各グループ名は、英文字から始まる必要があり、使用できる文字は英数字とアンダースコアのみです。 はい string
message body はい メッセージ
応答
コード 説明
202 Accepted

モデル

メッセージ

メソッド呼び出しメッセージ。

名前 タイプ 内容 必須
ターゲット (target) string ターゲット メソッド名。 いいえ
引数 [ object ] ターゲット メソッドの引数。 いいえ