Web Pub Sub - Close All Connections
Close the connections in the hub.
POST {endpoint}/api/hubs/{hub}/:closeConnections?api-version=2024-01-01POST {endpoint}/api/hubs/{hub}/:closeConnections?excluded={excluded}&reason={reason}&api-version=2024-01-01URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
|
endpoint
|
path | True |
string (url) |
HTTP or HTTPS endpoint for the Web PubSub service instance. |
|
hub
|
path | True |
string pattern: ^[A-Za-z][A-Za-z0-9_`,.[\]]{0,127}$ |
Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore. |
|
api-version
|
query | True |
string |
The version of the REST APIs. |
|
excluded
|
query |
string[] |
Exclude these connectionIds when closing the connections in the hub. |
|
|
reason
|
query |
string |
The reason closing the client connection. |
Responses
| Name | Type | Description |
|---|---|---|
| 204 No Content |
No Content |
|
| Other Status Codes |
Error response Headers x-ms-error-code: string |
Examples
WebPubSub_CloseAllConnections
Sample request
POST {endpoint}/api/hubs/hub1/:closeConnections?reason=Close reason&api-version=2024-01-01
Sample response
Definitions
| Name | Description |
|---|---|
|
Error |
The error object. |
|
Inner |
ErrorDetail
The error object.
| Name | Type | Description |
|---|---|---|
| code |
string |
One of a server-defined set of error codes. |
| details |
An array of details about specific errors that led to this reported error. |
|
| inner | ||
| message |
string |
A human-readable representation of the error. |
| target |
string |
The target of the error. |
InnerError
| Name | Type | Description |
|---|---|---|
| code |
string |
A more specific error code than was provided by the containing error. |
| inner |