Merge pull request #236211 from minnieliu/peiliu/updatePythonRoomsQuickStart

Update Python Rooms Quickstart according to new SDK

Author: v-regandowner

articles/communication-services/quickstarts/rooms/includes/rooms-quickstart-net.md

@@ -270,4 +270,4 @@ Deleted room with id: 99445276259151407
 
 ## Reference documentation
 
-Read about the full set of capabilities of Azure Communication Services re [.NET SDK reference](/dotnet/api/azure.communication.rooms) or [REST API reference](/rest/api/communication/rooms).
+Read about the full set of capabilities of Azure Communication Services rooms from the [.NET SDK reference](/dotnet/api/azure.communication.rooms) or [REST API reference](/rest/api/communication/rooms).

articles/communication-services/quickstarts/rooms/includes/rooms-quickstart-python.md

@@ -2,15 +2,15 @@
 title: include file
 description: include file
 services: azure-communication-services
-author: radubulboaca
-manager: mariusu
+author: peiliu
+manager: alexokun
 
 ms.service: azure-communication-services
 ms.subservice: azure-communication-services
-ms.date: 01/26/2022
+ms.date: 04/27/2023
 ms.topic: include
 ms.custom: include file
-ms.author: radubulboaca
+ms.author: peiliu
 ---
 
 ## Prerequisites
@@ -35,7 +35,7 @@ mkdir acs-rooms-quickstart && cd acs-rooms-quickstart
 
 ### Install the packages
 
-You'll need to use the Azure Communication Rooms client library for Python [version 1.0.0b2](https://pypi.org/project/azure-communication-rooms/) or above. 
+You'll need to use the Azure Communication Rooms client library for Python [version 1.0.0b3](https://pypi.org/project/azure-communication-rooms/) or above.
 
 From a console prompt, navigate to the directory containing the rooms.py file, then execute the following command:
 
@@ -55,11 +55,12 @@ from datetime import datetime, timedelta
 from azure.communication.rooms import (
     RoomsClient,
     RoomParticipant,
-    RoleType,
-    RoomJoinPolicy
+    ParticipantRole
+)
+from azure.communication.identity import (
+    CommunicationIdentityClient,
+    CommunicationUserIdentifier
 )
-from azure.communication.identity import CommunicationUserIdentifier
-
 class RoomsQuickstart(object):
     print("Azure Communication Services - Rooms Quickstart")
     #room method implementations goes here
@@ -74,96 +75,126 @@ Create a new `RoomsClient` object that will be used to create new `rooms` and ma
 
 ```python
 #Find your Communication Services resource in the Azure portal
-self.connection_string = os.getenv("COMMUNICATION_CONNECTION_STRING") or <COMMUNICATION_SAMPLES_CONNECTION_STRING>
+self.connection_string = '<connection_string>'
 self.rooms_client = RoomsClient.from_connection_string(self.connection_string)
 ```
 
 ## Create a room
 
-Create a new `room` with default properties using the code snippet below:
+Create a new `room` with default properties using the code snippet below. When defining participants, if a role is not specified, then it will be set to `Attendee` as default.
 
 ```python
-# Create a Room
+# Create a room
 valid_from = datetime.now()
 valid_until = valid_from + relativedelta(months=+1)
 
 # Create identities for users
-identity_client = CommunicationIdentityClient.from_connection_string(connection_string)
-user1 = identity_client.create_user_and_token(scopes=[CommunicationTokenScope.VOIP])
-user2 = identity_client.create_user_and_token(scopes=["voip"])
+identity_client = CommunicationIdentityClient.from_connection_string(self.connection_string)
+user1 = identity_client.create_user()
+user2 = identity_client.create_user()
+user3 = identity_client.create_user()
 
-participants = []
-participants.append(RoomParticipant(CommunicationUserIdentifier(user1.properties['id'])))
+participant_1 = RoomParticipant(communication_identifier=self.user1, role=ParticipantRole.PRESENTER)
+participant_2 = RoomParticipant(communication_identifier=self.user2, role=ParticipantRole.CONSUMER)
+participants = [participant_1, participant_2]
 
 try:
-    create_room_response = self.rooms_client.create_room(valid_from=valid_from, valid_until=valid_until, participants=participants)
-    print("\nCreated a room with id: " + create_room_response.id)
+    create_room = self.rooms_client.create_room(
+        valid_from=valid_from,
+        valid_until=valid_until,
+        participants=participants
+    )
+    print("\nCreated a room with id: " + create_room.id)
 except HttpResponseError as ex:
     print(ex)
 ```
 
-Since `rooms` are server-side entities, you may want to keep track of and persist the `roomId` in the storage medium of choice. You can reference the `roomId` to view or update the properties of a `room` object. 
+Since `rooms` are server-side entities, you may want to keep track of and persist the `room.id` in the storage medium of choice. You can reference the `id` to view or update the properties of a `room` object.
 
 ## Get properties of an existing room
 
-Retrieve the details of an existing `room` by referencing the `roomId`:
+Retrieve the details of an existing `room` by referencing the `id`:
 
 ```python
 # Retrieves the room with corresponding ID
+room_id = create_room.id
 try:
-    get_room_response = self.rooms_client.get_room(room_id=room_id)
-    print("\nRetrieved room with id: ", get_room_response.id);
-
+    get_room = self.rooms_client.get_room(room_id=room_id)
+    print("\nRetrieved room with id: ", get_room.id)
 except HttpResponseError as ex:
     print(ex)
 ```
 
 ## Update the lifetime of a room
 
-The lifetime of a `room` can be modified by issuing an update request for the `ValidFrom` and `ValidUntil` parameters. A room can be valid for a maximum of six months. 
+The lifetime of a `room` can be modified by issuing an update request for the `valid_from` and `valid_until` parameters. A room can be valid for a maximum of six months.
 
 ```python
-# set attributes you want to change
+# Update the lifetime of a room
 valid_from =  datetime.now()
 valid_until = valid_from + relativedelta(months=+1,days=+20)
 
 try:
-    update_room_response = self.rooms_client.update_room(room_id=room_id, valid_from=valid_from, valid_until=valid_until)
-    self.printRoom(response=update_room_response)
+    updated_room = self.rooms_client.update_room(room_id=room_id, valid_from=valid_from, valid_until=valid_until)
+     print("\nUpdated room with validFrom: " + updated_room.valid_from + " and validUntil: " + updated_room.valid_until)
 except HttpResponseError as ex:
     print(ex)
-``` 
+```
 
-## Add new participants 
+## List all active rooms
 
-To add new participants to a `room`, use the `add_participants` method exposed on the client.
+To retrieve all active rooms created under your resource, use the `list_rooms` method exposed on the client.
 
 ```python
+# List all active rooms
+try:
+    rooms = self.rooms_client.list_rooms()
+    count = 0
+        for room in rooms:
+            if count == 1:
+                break
+            print("\nPrinting the first room in list"
+              "\nRoom Id: " + room.id +
+              "\nCreated date time: " + str(room.created_at) +
+              "\nValid From: " + str(room.valid_from) + "\nValid Until: " + str(room.valid_until))
+            count += 1
+except HttpResponseError as ex:
+    print(ex)
+```
+
+## Add or update participants
 
-# Add Participants
+To add new participants or update existing participants in a `room`, use the `add_or_update_participants` method exposed on the client.
+
+```python
+# Add or update participants in a room
 try:
+    # Update existing user2 from consumer to attendee
     participants = []
-    participants.append(RoomParticipant(CommunicationUserIdentifier(user2.properties['id']), RoleType.ATTENDEE))
-    self.rooms_client.add_participants(room_id, participants)
-    print("\nAdded participants to room")
+    participants.append(RoomParticipant(self.user2, ParticipantRole.ATTENDEE))
 
-except Exception as ex:
-    print('Error in adding participants to room.', ex)
+    # Add new participant user3
+    participants.append(RoomParticipant(self.user3, ParticipantRole.CONSUMER))
+    self.rooms_client.add_or_update_participants(room_id=room_id, participants=participants)
+    print("\Add or update participants in room")
 
+except Exception as ex:
+    print('Error in adding or updating participants to room.', ex)
 ```
 
 Participants that have been added to a `room` become eligible to join calls.
 
-## Get list of participants
+## List participants in a room
 
-Retrieve the list of participants for an existing `room` by referencing the `roomId`:
+Retrieve the list of participants for an existing `room` by referencing the `room_id`:
 
 ```python
-
 # Get list of participants in room
 try:
-    participants = self.rooms_client.get_participants(room_id)
-    print("\nRetrieved participants for room: ", participants)
+    participants = self.rooms_client.list_participants(room_id)
+    print('\nParticipants in Room Id :', room_id)
+        for p in participants:
+            print(p.communication_identifier.properties['id'], p.role)
 except HttpResponseError as ex:
     print(ex)
 
@@ -174,40 +205,38 @@ except HttpResponseError as ex:
 To remove a participant from a `room` and revoke their access, use the `remove_participants` method.
 
 ```python
-
 # Remove Participants
-participants = [CommunicationUserIdentifier(user2.properties['id'])]
-
 try:
-    remove_participants_response = self.rooms_client.remove_participants(room_id=room_id, communication_identifiers=participants)
+    participants = [user2]
+    self.rooms_client.remove_participants(room_id=room_id, participants=participants)
     print("\nRemoved participants from room")
+
 except HttpResponseError as ex:
     print(ex)
 
 ```
 
 ## Delete room
-If you wish to disband an existing `room`, you may issue an explicit delete request. All `rooms` and their associated resources are automatically deleted at the end of their validity plus a grace period. 
+If you wish to disband an existing `room`, you may issue an explicit delete request. All `rooms` and their associated resources are automatically deleted at the end of their validity plus a grace period.
 
 ```python
-
 # Delete Room
+
 self.rooms_client.delete_room(room_id=room)
 print("\nDeleted room with id: " + room)
 
 ```
 
 ## Run the code
 
-To run the code, make sure you are on the directory where your `index.js` file is. 
+To run the code, make sure you are on the directory where your `rooms-quickstart.py` file is.
 
 ```console
 
 python rooms-quickstart.py
 
 ```
 
-
 The expected output describes each completed action:
 
 ```console
@@ -218,30 +247,24 @@ Created a room with id:  99445276259151407
 
 Retrieved room with id:  99445276259151407
 
-Updated room with validFrom:  2023-05-11T22:11:46.784Z  and validUntil:  2023-05-11T22:16:46.784Z
-
-Added participants to room
-
-Retrieved participants for room:  [
-  {
-    id: {
-      kind: 'communicationUser',
-      communicationUserId: '8:acs:b6aada1f-0b1d-47ac-866f-91aae00a1d01_00000018-ac89-7c76-35f3-343a0d00e901'
-    },
-    role: 'Attendee'
-  },
-  {
-    id: {
-      kind: 'communicationUser',
-      communicationUserId: '8:acs:b6aada1f-0b1d-47ac-866f-91aae00a1d01_00000018-ac89-7ccc-35f3-343a0d00e902'
-    },
-    role: 'Consumer'
-  }
-]
+Updated room with validFrom: 2023-05-03T00:00:00+00:00  and validUntil: 2023-06-23T00:00:00+00:00
+
+Printing the first room in list
+Room Id: 99445276259151407
+Created date time: 2023-05-03T00:00:00+00:00
+Valid From: 2023-05-03T00:00:00+00:00
+Valid Until: 2023-06-23T00:00:00+00:00
+
+Add or update participants in room
+
+Participants in Room Id : 99445276259151407
+8:acs:42a0ff0c-356d-4487-a288-ad0aad95d504_00000018-ef00-6042-a166-563a0d0051c1 Presenter
+8:acs:42a0ff0c-356d-4487-a288-ad0aad95d504_00000018-ef00-6136-a166-563a0d0051c2 Consumer
+8:acs:42a0ff0c-356d-4487-a288-ad0aad95d504_00000018-ef00-61fd-a166-563a0d0051c3 Attendee
 
 Removed participants from room
 
-Deleted room with id:  99445276259151407
+Deleted room with id: 99445276259151407
 
 ```