participants
Creates, updates, deletes, gets or lists a participants resource.
Overview
| Name | participants |
| Type | Resource |
| Id | azure.communication_rooms.participants |
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 |
|---|---|---|---|---|
update | update | room_id, endpoint | Update participants in a room. Update participants in a room. | |
list_raw | exec | room_id, endpoint | Get participants in a room. Get participants in a room. |
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: ) |
room_id | string | The id of the room to get participants from. Required. |
UPDATE examples
- update
Update participants in a room. Update participants in a room.
UPDATE azure.communication_rooms.participants
SET
-- No updatable properties
WHERE
room_id = '{{ room_id }}' --required
AND endpoint = '{{ endpoint }}' --required;
Lifecycle Methods
- list_raw
Get participants in a room. Get participants in a room.
EXEC azure.communication_rooms.participants.list_raw
@room_id='{{ room_id }}' --required,
@endpoint='{{ endpoint }}' --required
;