Share via


Web Pub Sub - Group Exists

Check if there are any client connections inside the given group

HEAD {endpoint}/api/hubs/{hub}/groups/{group}?api-version=2024-12-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.

Responses

Name Type Description
200 OK

OK

404 Not Found

Not Found

Other Status Codes

Error response

Headers

x-ms-error-code: string

Examples

WebPubSub_GroupExists

Sample request

HEAD {endpoint}/api/hubs/hub1/groups/group1?api-version=2024-12-01

Sample response