Azure SignalR Service データ プレーン REST API - v1
- [アーティクル]
-
-
この記事には、Azure SignalR Service データ プレーン用の v1 バージョンの REST API が記載されています。
利用可能な API
ターゲット ハブに接続されているすべてのクライアントにメッセージをブロードキャストします。
POST /api/v1/hubs/{hub}
パラメーター
| 名前 |
ロケーション |
説明 |
必須 |
[スキーマ] |
| ハブ |
path |
ターゲット ハブ名。これは、英文字から始まる必要があり、使用できる文字は英数字とアンダースコアのみです。 |
はい |
string |
| excluded |
query |
除外された接続 ID |
いいえ |
[ string ] |
応答
| コード |
説明 |
| 202 |
Success |
| 400 |
Bad Request |
ターゲット ユーザーに属するすべてのクライアントにメッセージをブロードキャストします。
POST /api/v1/hubs/{hub}/users/{id}
パラメーター
| 名前 |
ロケーション |
説明 |
必須 |
[スキーマ] |
| ハブ |
path |
ターゲット ハブ名。これは、英文字から始まる必要があり、使用できる文字は英数字とアンダースコアのみです。 |
はい |
string |
| id |
path |
ユーザー ID。 |
はい |
string |
応答
| コード |
説明 |
| 202 |
Success |
| 400 |
Bad Request |
特定の接続にメッセージを送信します。
POST /api/v1/hubs/{hub}/connections/{connectionId}
パラメーター
| 名前 |
ロケーション |
説明 |
必須 |
[スキーマ] |
| ハブ |
path |
ターゲット ハブ名。これは、英文字から始まる必要があり、使用できる文字は英数字とアンダースコアのみです。 |
はい |
string |
| connectionId |
path |
接続 ID。 |
はい |
string |
応答
| コード |
説明 |
| 202 |
Success |
| 400 |
Bad Request |
指定された connectionId との接続が存在するかどうかを確認します
GET /api/v1/hubs/{hub}/connections/{connectionId}
パラメーター
| 名前 |
ロケーション |
説明 |
必須 |
[スキーマ] |
| ハブ |
path |
|
はい |
string |
| connectionId |
path |
|
はい |
string |
応答
| コード |
説明 |
| 200 |
成功 |
| 400 |
Bad Request |
| 404 |
Not Found |
クライアント接続を閉じます
DELETE /api/v1/hubs/{hub}/connections/{connectionId}
パラメーター
| 名前 |
ロケーション |
説明 |
必須 |
[スキーマ] |
| ハブ |
path |
|
はい |
string |
| connectionId |
path |
|
はい |
string |
| reason |
query |
|
いいえ |
string |
応答
| コード |
説明 |
| 202 |
Success |
| 400 |
Bad Request |
ターゲット グループ内のすべてのクライアントにメッセージをブロードキャストします。
POST /api/v1/hubs/{hub}/groups/{group}
パラメーター
| 名前 |
ロケーション |
説明 |
必須 |
[スキーマ] |
| ハブ |
path |
ターゲット ハブ名。これは、英文字から始まる必要があり、使用できる文字は英数字とアンダースコアのみです。 |
はい |
string |
| グループ |
path |
ターゲット グループ名。長さは 0 より長く、1025 未満である必要があります。 |
はい |
string |
| excluded |
query |
除外された接続 ID |
いいえ |
[ string ] |
応答
| コード |
説明 |
| 202 |
Success |
| 400 |
Bad Request |
特定のグループ内にクライアント接続があるかどうかを確認します
GET /api/v1/hubs/{hub}/groups/{group}
パラメーター
| 名前 |
ロケーション |
説明 |
必須 |
[スキーマ] |
| ハブ |
path |
|
はい |
string |
| グループ |
path |
|
はい |
string |
応答
| コード |
説明 |
| 200 |
成功 |
| 400 |
Bad Request |
| 404 |
Not Found |
特定のユーザーに接続されているクライアント接続があるかどうかを確認します
GET /api/v1/hubs/{hub}/users/{user}
パラメーター
| 名前 |
ロケーション |
説明 |
必須 |
[スキーマ] |
| ハブ |
path |
|
はい |
string |
| ユーザー |
path |
|
はい |
string |
応答
| コード |
説明 |
| 200 |
成功 |
| 400 |
Bad Request |
| 404 |
Not Found |
ターゲット グループに接続を追加します。
PUT /api/v1/hubs/{hub}/groups/{group}/connections/{connectionId}
パラメーター
| 名前 |
ロケーション |
説明 |
必須 |
[スキーマ] |
| ハブ |
path |
ターゲット ハブ名。これは、英文字から始まる必要があり、使用できる文字は英数字とアンダースコアのみです。 |
はい |
string |
| グループ |
path |
ターゲット グループ名。長さは 0 より長く、1025 未満である必要があります。 |
はい |
string |
| connectionId |
path |
ターゲット接続 ID |
はい |
string |
応答
| コード |
説明 |
| 200 |
成功 |
| 400 |
Bad Request |
| 404 |
Not Found |
ターゲット グループから接続を削除します。
DELETE /api/v1/hubs/{hub}/groups/{group}/connections/{connectionId}
パラメーター
| 名前 |
ロケーション |
説明 |
必須 |
[スキーマ] |
| ハブ |
path |
ターゲット ハブ名。これは、英文字から始まる必要があり、使用できる文字は英数字とアンダースコアのみです。 |
はい |
string |
| グループ |
path |
ターゲット グループ名。長さは 0 より長く、1025 未満である必要があります。 |
はい |
string |
| connectionId |
path |
ターゲット接続 ID |
はい |
string |
応答
| コード |
説明 |
| 200 |
成功 |
| 400 |
Bad Request |
| 404 |
Not Found |
ユーザーがターゲット グループに存在するかどうかを確認します。
GET /api/v1/hubs/{hub}/groups/{group}/users/{user}
パラメーター
| 名前 |
ロケーション |
説明 |
必須 |
[スキーマ] |
| ハブ |
path |
ターゲット ハブ名。これは、英文字から始まる必要があり、使用できる文字は英数字とアンダースコアのみです。 |
はい |
string |
| グループ |
path |
ターゲット グループ名。長さは 0 より長く、1025 未満である必要があります。 |
はい |
string |
| ユーザー |
path |
ターゲット ユーザー ID |
はい |
string |
応答
| コード |
説明 |
| 200 |
成功 |
| 400 |
Bad Request |
| 404 |
Not Found |
ターゲット グループにユーザーを追加します。
PUT /api/v1/hubs/{hub}/groups/{group}/users/{user}
パラメーター
| 名前 |
ロケーション |
説明 |
必須 |
[スキーマ] |
| ハブ |
path |
ターゲット ハブ名。これは、英文字から始まる必要があり、使用できる文字は英数字とアンダースコアのみです。 |
はい |
string |
| グループ |
path |
ターゲット グループ名。長さは 0 より長く、1025 未満である必要があります。 |
はい |
string |
| ユーザー |
path |
ターゲット ユーザー ID |
はい |
string |
| ttl |
query |
ユーザーがグループ内に存在する秒数を指定します。 設定しない場合、ユーザーはグループ内に最大 1 年間存在します。 ttl を設定しない場合、サービスではユーザーごとに 100 のユーザー グループ関係を保持し、古いユーザー グループ関係は新しく追加されたもので上書きされることに注意してください。 |
いいえ |
integer |
応答
| コード |
説明 |
| 202 |
Success |
| 400 |
Bad Request |
ターゲット グループからユーザーを削除します。
DELETE /api/v1/hubs/{hub}/groups/{group}/users/{user}
パラメーター
| 名前 |
ロケーション |
説明 |
必須 |
[スキーマ] |
| ハブ |
path |
ターゲット ハブ名。これは、英文字から始まる必要があり、使用できる文字は英数字とアンダースコアのみです。 |
はい |
string |
| グループ |
path |
ターゲット グループ名。長さは 0 より長く、1025 未満である必要があります。 |
はい |
string |
| ユーザー |
path |
ターゲット ユーザー ID |
はい |
string |
応答
| コード |
説明 |
| 202 |
Success |
| 400 |
Bad Request |
ユーザーをすべてのグループから削除します。
DELETE /api/v1/hubs/{hub}/users/{user}/groups
パラメーター
| 名前 |
ロケーション |
説明 |
必須 |
[スキーマ] |
| ハブ |
path |
ターゲット ハブ名。これは、英文字から始まる必要があり、使用できる文字は英数字とアンダースコアのみです。 |
はい |
string |
| ユーザー |
path |
ターゲット ユーザー ID |
はい |
string |
応答
| コード |
説明 |
| 200 |
ユーザーが削除されます |
| 202 |
削除要求が受け入れられ、サービスではバックグラウンドでその要求を処理しています |
| 400 |
Bad Request |
モデル
PayloadMessage
| 名前 |
タイプ |
内容 |
必須 |
| 移行先 |
string |
|
いいえ |
| 引数 |
[ object ] |
|
いいえ |