connections_in_groups
Creates, updates, deletes, gets or lists a connections_in_groups resource.
Overview
| Name | connections_in_groups |
| Type | Resource |
| Id | azure.messaging_webpubsubservice.connections_in_groups |
Fields
The following fields are returned by SELECT queries:
- list_connections_in_group
| Name | Datatype | Description |
|---|---|---|
connectionId | string | Connection Id. Required. |
userId | string | User Id. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list_connections_in_group | select | group_name, hub, endpoint | maxpagesize, top, continuationToken | List connections in a group. List connections in a 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, whose length should be greater than 0 and less than 1025. Required. |
hub | string | |
continuationToken | string | A token that allows the client to retrieve the next page of results. This parameter is provided by the service in the response of a previous request when there are additional results to be fetched. Clients should include the continuationToken in the next request to receive the subsequent page of data. If this parameter is omitted, the server will return the first page of results. Default value is None. |
maxpagesize | integer | |
top | integer | The maximum number of connections to return. If the value is not set, then all the connections in a group are returned. Default value is None. |
SELECT examples
- list_connections_in_group
List connections in a group. List connections in a group.
SELECT
connectionId,
userId
FROM azure.messaging_webpubsubservice.connections_in_groups
WHERE group_name = '{{ group_name }}' -- required
AND hub = '{{ hub }}' -- required
AND endpoint = '{{ endpoint }}' -- required
AND maxpagesize = '{{ maxpagesize }}'
AND top = '{{ top }}'
AND continuationToken = '{{ continuationToken }}'
;