close_connections
Creates, updates, deletes, gets or lists a close_connections resource.
Overview
| Name | close_connections |
| Type | Resource |
| Id | azure.messaging_webpubsubservice.close_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_connection | delete | connection_id, hub, endpoint | reason | Close the client connection. Close the client connection. |
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 |
|---|---|---|
connection_id | string | Target connection Id. Required. |
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 | |
reason | string | The reason closing the client connection. Default value is None. |
DELETE examples
- close_connection
Close the client connection. Close the client connection.
DELETE FROM azure.messaging_webpubsubservice.close_connections
WHERE connection_id = '{{ connection_id }}' --required
AND hub = '{{ hub }}' --required
AND endpoint = '{{ endpoint }}' --required
AND reason = '{{ reason }}'
;