rooms

Creates, updates, deletes, gets or lists a rooms resource.

Overview

Name	rooms
Type	Resource
Id	azure.communication_rooms.rooms

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
create	insert	endpoint		Creates a new room. Creates a new room.
update	update	room_id, endpoint		Update a room with given changes. Update a room with given changes.
delete	delete	room_id, endpoint		Delete a room. Delete a room.
get_raw	exec	room_id, endpoint		Retrieves an existing room by id. Retrieves an existing room by id.
list_raw	exec	endpoint		Retrieves all created rooms. Retrieves all created rooms.

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 requested. Required.

INSERT examples

create

Creates a new room. Creates a new room.

INSERT INTO azure.communication_rooms.rooms (
endpoint
)
SELECT 
'{{ endpoint }}'
;

Manifest

# Description fields are for documentation purposes
- name: rooms
props:
  - name: endpoint
    value: "{{ endpoint }}"
    description: Required parameter for the rooms resource.

UPDATE examples

update

Update a room with given changes. Update a room with given changes.

UPDATE azure.communication_rooms.rooms
SET 
-- No updatable properties
WHERE 
room_id = '{{ room_id }}' --required
AND endpoint = '{{ endpoint }}' --required;

DELETE examples

delete

Delete a room. Delete a room.

DELETE FROM azure.communication_rooms.rooms
WHERE room_id = '{{ room_id }}' --required
AND endpoint = '{{ endpoint }}' --required
;

Lifecycle Methods

get_raw

Retrieves an existing room by id. Retrieves an existing room by id.

EXEC azure.communication_rooms.rooms.get_raw 
@room_id='{{ room_id }}' --required, 
@endpoint='{{ endpoint }}' --required
;

list_raw

Retrieves all created rooms. Retrieves all created rooms.

EXEC azure.communication_rooms.rooms.list_raw 
@endpoint='{{ endpoint }}' --required
;