close_group_connections
Creates, updates, deletes, gets or lists a close_group_connections resource.
Overview​
| Name | close_group_connections |
| Type | Resource |
| Id | azure.messaging_webpubsubservice.close_group_connections |
Fields​
The following fields are returned by SELECT queries:
SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
close_group_connections | exec | group_name, hub, endpoint | reason | Close connections in the specific group. Close connections in the specific group. |
Parameters​
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
endpoint | string | The service endpoint host (no scheme), e.g. myaccount.table.cosmos.azure.com:443 - value of the client endpoint parameter. (default: ) |
group_name | string | Target group name, which length should be greater than 0 and less than 1025. Required. |
hub | string | |
reason | string | The reason closing the client connection. Default value is None. |
Lifecycle Methods​
- close_group_connections
Close connections in the specific group. Close connections in the specific group.
EXEC azure.messaging_webpubsubservice.close_group_connections.close_group_connections
@group_name='{{ group_name }}' --required,
@hub='{{ hub }}' --required,
@endpoint='{{ endpoint }}' --required,
@reason='{{ reason }}'
;