Azure SignalR Service REST API
- [アーティクル]
-
-
バージョン: 2022-06-01
利用可能な API
/api/health
HEAD
まとめ
サービスの正常性状態を取得します。
サービスの正常性状態を取得する
HEAD /api/health
パラメーター
| 名前 |
ロケーション |
説明 |
必須 |
[スキーマ] |
| api-version |
query |
REST API のバージョン。 |
はい |
string |
応答
| コード |
説明 |
| 200 |
サービスは正常な状態です |
| default |
エラー応答 |
/api/hubs/{hub}/:closeConnections
投稿
まとめ
ハブ内のすべての接続を閉じます。
ハブ内のすべての接続を閉じる
POST /api/hubs/{hub}/:closeConnections
パラメーター
| 名前 |
ロケーション |
説明 |
必須 |
[スキーマ] |
| ハブ |
path |
ターゲット ハブ名。これは、英文字から始まる必要があり、使用できる文字は英数字とアンダースコアのみです。 |
はい |
string |
| アプリケーション |
query |
ターゲット アプリケーションの名前。これは、英文字で始まり、英数字とアンダースコアのみを使用できます。 |
いいえ |
string |
| excluded |
query |
ハブで接続を閉じるときに、これらの connectionId を除外します。 |
いいえ |
[ string ] |
| reason |
query |
クライアント接続を閉じる理由。 |
いいえ |
string |
| api-version |
query |
REST API のバージョン。 |
はい |
string |
応答
/api/hubs/{hub}/:send
投稿
まとめ
ターゲット ハブに接続されているすべてのクライアントにメッセージをブロードキャストします。
ターゲット ハブに接続されているすべてのクライアントにメッセージをブロードキャストする
POST /api/hubs/{hub}/:send
パラメーター
| 名前 |
ロケーション |
説明 |
必須 |
[スキーマ] |
| ハブ |
path |
ターゲット ハブ名。これは、英文字から始まる必要があり、使用できる文字は英数字とアンダースコアのみです。 |
はい |
string |
| アプリケーション |
query |
ターゲット アプリケーションの名前。これは、英文字で始まり、英数字とアンダースコアのみを使用できます。 |
いいえ |
string |
| excluded |
query |
除外された接続 ID |
いいえ |
[ string ] |
| api-version |
query |
REST API のバージョン。 |
はい |
string |
| message |
body |
ペイロード メッセージ。 |
はい |
PayloadMessage |
応答
/api/hubs/{hub}/connections/{connectionId}
HEAD
まとめ
指定された connectionId との接続が存在するかどうかを確認します
指定された connectionId との接続が存在するかどうかを確認します
HEAD /api/hubs/{hub}/connections/{connectionId}
パラメーター
| 名前 |
ロケーション |
説明 |
必須 |
[スキーマ] |
| ハブ |
path |
ターゲット ハブ名。これは、英文字から始まる必要があり、使用できる文字は英数字とアンダースコアのみです。 |
はい |
string |
| connectionId |
path |
接続 ID。 |
はい |
string |
| アプリケーション |
query |
ターゲット アプリケーションの名前。これは、英文字で始まり、英数字とアンダースコアのみを使用できます。 |
いいえ |
string |
| api-version |
query |
REST API のバージョン。 |
はい |
string |
応答
DELETE
まとめ
クライアント接続を閉じます
クライアント接続を閉じます
DELETE /api/hubs/{hub}/connections/{connectionId}
パラメーター
| 名前 |
ロケーション |
説明 |
必須 |
[スキーマ] |
| ハブ |
path |
ターゲット ハブ名。これは、英文字から始まる必要があり、使用できる文字は英数字とアンダースコアのみです。 |
はい |
string |
| connectionId |
path |
接続 ID。 |
はい |
string |
| アプリケーション |
query |
ターゲット アプリケーションの名前。これは、英文字で始まり、英数字とアンダースコアのみを使用できます。 |
いいえ |
string |
| reason |
query |
接続を閉じる理由。 |
いいえ |
string |
| api-version |
query |
REST API のバージョン。 |
はい |
string |
応答
/api/hubs/{hub}/connections/{connectionId}/:send
投稿
まとめ
特定の接続にメッセージを送信します。
特定の接続にメッセージを送信する
POST /api/hubs/{hub}/connections/{connectionId}/:send
パラメーター
| 名前 |
ロケーション |
説明 |
必須 |
[スキーマ] |
| ハブ |
path |
ターゲット ハブ名。これは、英文字から始まる必要があり、使用できる文字は英数字とアンダースコアのみです。 |
はい |
string |
| connectionId |
path |
接続 ID。 |
はい |
string |
| アプリケーション |
query |
ターゲット アプリケーションの名前。これは、英文字で始まり、英数字とアンダースコアのみを使用できます。 |
いいえ |
string |
| api-version |
query |
REST API のバージョン。 |
はい |
string |
| message |
body |
ペイロード メッセージ。 |
はい |
PayloadMessage |
応答
/api/hubs/{hub}/groups/{group}
HEAD
まとめ
特定のグループ内にクライアント接続があるかどうかを確認します
特定のグループ内にクライアント接続があるかどうかを確認します
HEAD /api/hubs/{hub}/groups/{group}
パラメーター
| 名前 |
ロケーション |
説明 |
必須 |
[スキーマ] |
| ハブ |
path |
ターゲット ハブ名。これは、英文字から始まる必要があり、使用できる文字は英数字とアンダースコアのみです。 |
はい |
string |
| グループ |
path |
ターゲット グループ名。長さは 0 より長く、1025 未満である必要があります。 |
はい |
string |
| アプリケーション |
query |
ターゲット アプリケーションの名前。これは、英文字で始まり、英数字とアンダースコアのみを使用できます。 |
いいえ |
string |
| api-version |
query |
REST API のバージョン。 |
はい |
string |
応答
/api/hubs/{hub}/groups/{group}/:closeConnections
投稿
まとめ
特定のグループの接続を閉じます。
特定のグループの接続を閉じる
POST /api/hubs/{hub}/groups/{group}/:closeConnections
パラメーター
| 名前 |
ロケーション |
説明 |
必須 |
[スキーマ] |
| ハブ |
path |
ターゲット ハブ名。これは、英文字から始まる必要があり、使用できる文字は英数字とアンダースコアのみです。 |
はい |
string |
| グループ |
path |
ターゲット グループ名。長さは 0 より長く、1025 未満である必要があります。 |
はい |
string |
| アプリケーション |
query |
ターゲット アプリケーションの名前。これは、英文字で始まり、英数字とアンダースコアのみを使用できます。 |
いいえ |
string |
| excluded |
query |
ハブで接続を閉じるときに、これらの connectionId を除外します。 |
いいえ |
[ string ] |
| reason |
query |
クライアント接続を閉じる理由。 |
いいえ |
string |
| api-version |
query |
REST API のバージョン。 |
はい |
string |
応答
/api/hubs/{hub}/groups/{group}/:send
投稿
まとめ
ターゲット グループ内のすべてのクライアントにメッセージをブロードキャストします。
ターゲット グループ内のすべてのクライアントにメッセージをブロードキャストする
POST /api/hubs/{hub}/groups/{group}/:send
パラメーター
| 名前 |
ロケーション |
説明 |
必須 |
[スキーマ] |
| ハブ |
path |
ターゲット ハブ名。これは、英文字から始まる必要があり、使用できる文字は英数字とアンダースコアのみです。 |
はい |
string |
| グループ |
path |
ターゲット グループ名。長さは 0 より長く、1025 未満である必要があります。 |
はい |
string |
| アプリケーション |
query |
ターゲット アプリケーションの名前。これは、英文字で始まり、英数字とアンダースコアのみを使用できます。 |
いいえ |
string |
| excluded |
query |
除外された接続 ID |
いいえ |
[ string ] |
| api-version |
query |
REST API のバージョン。 |
はい |
string |
| message |
body |
ペイロード メッセージ。 |
はい |
PayloadMessage |
応答
/api/hubs/{hub}/groups/{group}/connections/{connectionId}
PUT
まとめ
ターゲット グループに接続を追加します。
ターゲット グループに接続を追加する
PUT /api/hubs/{hub}/groups/{group}/connections/{connectionId}
パラメーター
| 名前 |
ロケーション |
説明 |
必須 |
[スキーマ] |
| ハブ |
path |
ターゲット ハブ名。これは、英文字から始まる必要があり、使用できる文字は英数字とアンダースコアのみです。 |
はい |
string |
| グループ |
path |
ターゲット グループ名。長さは 0 より長く、1025 未満である必要があります。 |
はい |
string |
| connectionId |
path |
ターゲット接続 ID |
はい |
string |
| アプリケーション |
query |
ターゲット アプリケーションの名前。これは、英文字で始まり、英数字とアンダースコアのみを使用できます。 |
いいえ |
string |
| api-version |
query |
REST API のバージョン。 |
はい |
string |
応答
DELETE
まとめ
ターゲット グループから接続を削除します。
ターゲット グループから接続を削除する
DELETE /api/hubs/{hub}/groups/{group}/connections/{connectionId}
パラメーター
| 名前 |
ロケーション |
説明 |
必須 |
[スキーマ] |
| ハブ |
path |
ターゲット ハブ名。これは、英文字から始まる必要があり、使用できる文字は英数字とアンダースコアのみです。 |
はい |
string |
| グループ |
path |
ターゲット グループ名。長さは 0 より長く、1025 未満である必要があります。 |
はい |
string |
| connectionId |
path |
ターゲット接続 ID |
はい |
string |
| アプリケーション |
query |
ターゲット アプリケーションの名前。これは、英文字で始まり、英数字とアンダースコアのみを使用できます。 |
いいえ |
string |
| api-version |
query |
REST API のバージョン。 |
はい |
string |
応答
/api/hubs/{hub}/connections/{connectionId}/groups
DELETE
まとめ
すべてのグループから接続を削除する
すべてのグループから接続を削除する
DELETE /api/hubs/{hub}/connections/{connectionId}/groups
パラメーター
| 名前 |
ロケーション |
説明 |
必須 |
[スキーマ] |
| ハブ |
path |
ターゲット ハブ名。これは、英文字から始まる必要があり、使用できる文字は英数字とアンダースコアのみです。 |
はい |
string |
| connectionId |
path |
ターゲット接続 ID |
はい |
string |
| アプリケーション |
query |
ターゲット アプリケーションの名前。これは、英文字で始まり、英数字とアンダースコアのみを使用できます。 |
いいえ |
string |
| api-version |
query |
REST API のバージョン。 |
はい |
string |
応答
/api/hubs/{hub}/users/{user}
HEAD
まとめ
特定のユーザーに接続されているクライアント接続があるかどうかを確認します
特定のユーザーに接続されているクライアント接続があるかどうかを確認します
HEAD /api/hubs/{hub}/users/{user}
パラメーター
| 名前 |
ロケーション |
説明 |
必須 |
[スキーマ] |
| ハブ |
path |
ターゲット ハブ名。これは、英文字から始まる必要があり、使用できる文字は英数字とアンダースコアのみです。 |
はい |
string |
| ユーザー |
path |
ユーザー ID。 |
はい |
string |
| アプリケーション |
query |
ターゲット アプリケーションの名前。これは、英文字で始まり、英数字とアンダースコアのみを使用できます。 |
いいえ |
string |
| api-version |
query |
REST API のバージョン。 |
はい |
string |
応答
/api/hubs/{hub}/users/{user}/:closeConnections
投稿
まとめ
特定のユーザーとの接続を閉じます。
特定のユーザーとの接続を閉じる
POST /api/hubs/{hub}/users/{user}/:closeConnections
パラメーター
| 名前 |
ロケーション |
説明 |
必須 |
[スキーマ] |
| ハブ |
path |
ターゲット ハブ名。これは、英文字から始まる必要があり、使用できる文字は英数字とアンダースコアのみです。 |
はい |
string |
| ユーザー |
path |
ユーザー ID。 |
はい |
string |
| アプリケーション |
query |
ターゲット アプリケーションの名前。これは、英文字で始まり、英数字とアンダースコアのみを使用できます。 |
いいえ |
string |
| excluded |
query |
ハブで接続を閉じるときに、これらの connectionId を除外します。 |
いいえ |
[ string ] |
| reason |
query |
クライアント接続を閉じる理由。 |
いいえ |
string |
| api-version |
query |
REST API のバージョン。 |
はい |
string |
応答
/api/hubs/{hub}/users/{user}/:send
投稿
まとめ
ターゲット ユーザーに属するすべてのクライアントにメッセージをブロードキャストします。
ターゲット ユーザーに属するすべてのクライアントにメッセージをブロードキャストする
POST /api/hubs/{hub}/users/{user}/:send
パラメーター
| 名前 |
ロケーション |
説明 |
必須 |
[スキーマ] |
| ハブ |
path |
ターゲット ハブ名。これは、英文字から始まる必要があり、使用できる文字は英数字とアンダースコアのみです。 |
はい |
string |
| ユーザー |
path |
ユーザー ID。 |
はい |
string |
| アプリケーション |
query |
ターゲット アプリケーションの名前。これは、英文字で始まり、英数字とアンダースコアのみを使用できます。 |
いいえ |
string |
| api-version |
query |
REST API のバージョン。 |
はい |
string |
| message |
body |
ペイロード メッセージ。 |
はい |
PayloadMessage |
応答
/api/hubs/{hub}/users/{user}/groups/{group}
HEAD
まとめ
ユーザーがターゲット グループに存在するかどうかを確認します。
ユーザーがターゲット グループに存在するかどうかを確認する
HEAD /api/hubs/{hub}/users/{user}/groups/{group}
パラメーター
| 名前 |
ロケーション |
説明 |
必須 |
[スキーマ] |
| ハブ |
path |
ターゲット ハブ名。これは、英文字から始まる必要があり、使用できる文字は英数字とアンダースコアのみです。 |
はい |
string |
| グループ |
path |
ターゲット グループ名。長さは 0 より長く、1025 未満である必要があります。 |
はい |
string |
| ユーザー |
path |
ターゲット ユーザー ID |
はい |
string |
| アプリケーション |
query |
ターゲット アプリケーションの名前。これは、英文字で始まり、英数字とアンダースコアのみを使用できます。 |
いいえ |
string |
| api-version |
query |
REST API のバージョン。 |
はい |
string |
応答
PUT
まとめ
ターゲット グループにユーザーを追加します。
ターゲット グループにユーザーを追加する
PUT /api/hubs/{hub}/users/{user}/groups/{group}
パラメーター
| 名前 |
ロケーション |
説明 |
必須 |
[スキーマ] |
| ハブ |
path |
ターゲット ハブ名。これは、英文字から始まる必要があり、使用できる文字は英数字とアンダースコアのみです。 |
はい |
string |
| グループ |
path |
ターゲット グループ名。長さは 0 より長く、1025 未満である必要があります。 |
はい |
string |
| ユーザー |
path |
ターゲット ユーザー ID |
はい |
string |
| アプリケーション |
query |
ターゲット アプリケーションの名前。これは、英文字で始まり、英数字とアンダースコアのみを使用できます。 |
いいえ |
string |
| ttl |
query |
ユーザーがグループ内に存在する秒数を指定します。 設定しない場合、ユーザーはグループ内に最大 1 年間存在します。 ttl 制限なしでユーザーが一部のグループに追加された場合、TTL なしで参加したすべてのグループの中でユーザーが予約されるのは、更新された最新の 100 グループだけです。 ttl = 0 の場合、ターゲット ユーザーの現在の接続中の接続のみがターゲット グループに追加されます。 |
いいえ |
integer |
| api-version |
query |
REST API のバージョン。 |
はい |
string |
応答
DELETE
まとめ
ターゲット グループからユーザーを削除します。
ターゲット グループからユーザーを削除する
DELETE /api/hubs/{hub}/users/{user}/groups/{group}
パラメーター
| 名前 |
ロケーション |
説明 |
必須 |
[スキーマ] |
| ハブ |
path |
ターゲット ハブ名。これは、英文字から始まる必要があり、使用できる文字は英数字とアンダースコアのみです。 |
はい |
string |
| グループ |
path |
ターゲット グループ名。長さは 0 より長く、1025 未満である必要があります。 |
はい |
string |
| ユーザー |
path |
ターゲット ユーザー ID |
はい |
string |
| アプリケーション |
query |
ターゲット アプリケーションの名前。これは、英文字で始まり、英数字とアンダースコアのみを使用できます。 |
いいえ |
string |
| api-version |
query |
REST API のバージョン。 |
はい |
string |
応答
/api/hubs/{hub}/users/{user}/groups
DELETE
まとめ
ユーザーをすべてのグループから削除します。
ユーザーをすべてのグループから削除する
DELETE /api/hubs/{hub}/users/{user}/groups
パラメーター
| 名前 |
ロケーション |
説明 |
必須 |
[スキーマ] |
| ハブ |
path |
ターゲット ハブ名。これは、英文字から始まる必要があり、使用できる文字は英数字とアンダースコアのみです。 |
はい |
string |
| ユーザー |
path |
ターゲット ユーザー ID |
はい |
string |
| アプリケーション |
query |
ターゲット アプリケーションの名前。これは、英文字で始まり、英数字とアンダースコアのみを使用できます。 |
いいえ |
string |
| api-version |
query |
REST API のバージョン。 |
はい |
string |
応答
モデル
ErrorDetail
エラー オブジェクト。
| 名前 |
種類 |
内容 |
必須 |
| コード |
string |
サーバー定義のエラー コードのセットの 1 つ。 |
いいえ |
| message |
string |
人による読み取りが可能なエラーの表現です。 |
いいえ |
| ターゲット (target) |
string |
エラーの対象。 |
いいえ |
| 詳細 |
[ ErrorDetail ] |
この報告されたエラーの原因となる特定のエラーに関する詳細の配列です。 |
いいえ |
| inner |
InnerError |
|
いいえ |
InnerError
| 名前 |
種類 |
内容 |
必須 |
| コード |
string |
含まれているエラーによって提供されたものよりも具体的なエラー コード。 |
いいえ |
| inner |
InnerError |
|
いいえ |
PayloadMessage
| 名前 |
種類 |
内容 |
必須 |
| ターゲット (target) |
string |
|
はい |
| 引数 |
[ ] |
|
いいえ |
ServiceResponse
| 名前 |
種類 |
内容 |
必須 |
| コード |
string |
|
いいえ |
| level |
string |
Enum: "Info"、 "Warning"、 "Error" |
いいえ |
| scope |
string |
Enum: "Unknown"、 "Request"、 "Connection"、 "User"、 "Group" |
いいえ |
| errorKind |
string |
Enum: "Unknown"、 "NotExisted"、 "NotInGroup"、 "Invalid" |
いいえ |
| message |
string |
|
いいえ |
| jsonObject |
|
|
いいえ |
| IsSuccess |
boolean |
|
いいえ |