add_user_to_groups
Creates, updates, deletes, gets or lists an add_user_to_groups resource.
Overview
| Name | add_user_to_groups |
| Type | Resource |
| Id | azure.messaging_webpubsubservice.add_user_to_groups |
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 |
|---|---|---|---|---|
add_user_to_group | exec | group_name, user_id, hub, endpoint | Add a user to the target group. Add a user to the target 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 | |
user_id | string | Target user Id. Required. |
Lifecycle Methods
- add_user_to_group
Add a user to the target group. Add a user to the target group.
EXEC azure.messaging_webpubsubservice.add_user_to_groups.add_user_to_group
@group_name='{{ group_name }}' --required,
@user_id='{{ user_id }}' --required,
@hub='{{ hub }}' --required,
@endpoint='{{ endpoint }}' --required
;