close_user_connections
Creates, updates, deletes, gets or lists a close_user_connections resource.
Overview
| Name | close_user_connections |
| Type | Resource |
| Id | azure.messaging_webpubsubservice.close_user_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_user_connections | exec | user_id, hub, endpoint | reason | Close connections for the specific user. Close connections for the specific user. |
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: ) |
hub | string | |
user_id | string | The user Id. Required. |
reason | string | The reason closing the client connection. Default value is None. |
Lifecycle Methods
- close_user_connections
Close connections for the specific user. Close connections for the specific user.
EXEC azure.messaging_webpubsubservice.close_user_connections.close_user_connections
@user_id='{{ user_id }}' --required,
@hub='{{ hub }}' --required,
@endpoint='{{ endpoint }}' --required,
@reason='{{ reason }}'
;