Share via

Web Pub Sub - Close Group Connections

Service:
Azure Web PubSub Service
API Version:
2024-01-01

Close connections in the specific group.

POST {endpoint}/api/hubs/{hub}/groups/{group}/:closeConnections?api-version=2024-01-01
With optional parameters: 
POST {endpoint}/api/hubs/{hub}/groups/{group}/:closeConnections?excluded={excluded}&reason={reason}&api-version=2024-01-01

URI Parameters

Name In Required Type Description
endpoint
 path True

string (url)

HTTP or HTTPS endpoint for the Web PubSub service instance.
group
 path True

string

minLength: 1
maxLength: 1024
pattern: ^(?!\s+$).+$

Target group name, which length should be greater than 0 and less than 1025.
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 group.
reason
 query

string

The reason closing the client connection.

Responses

Name Type Description
204 No Content

No Content
Other Status Codes

ErrorDetail

Error response

Headers

x-ms-error-code: string

Examples

WebPubSub_CloseGroupConnections

Sample request

POST {endpoint}/api/hubs/hub1/groups/group1/:closeConnections?reason=Close reason&api-version=2024-01-01

Sample response

Status code:
204

Definitions

Name Description
ErrorDetail

The error object.
InnerError

ErrorDetail

Object

The error object.

Name Type Description
code

string

One of a server-defined set of error codes.
details

ErrorDetail[]

An array of details about specific errors that led to this reported error.
inner

InnerError

message

string

A human-readable representation of the error.
target

string

The target of the error.

InnerError

Object
Name Type Description
code

string

A more specific error code than was provided by the containing error.
inner

InnerError