Libreria client di Azure Communication Rooms per Python - versione 1.0.0

Articolo
06/14/2023

Questo pacchetto contiene un SDK Python per Servizi di comunicazione di Azure per Rooms. Altre informazioni su Servizi di comunicazione di Azure qui

Dichiarazione di non responsabilità

Il supporto dei pacchetti Python di Azure SDK per Python 2.7 è terminato 01 gennaio 2022. Per altre informazioni e domande, vedere https://github.com/Azure/azure-sdk-for-python/issues/20691

Concetti chiave

Il pacchetto Azure Communication Rooms viene usato per eseguire le operazioni seguenti:

Creare riunioni pianificate
Creare riunioni con autorizzazioni gestite per i partecipanti

Introduzione

Installazione del pacchetto

python -m pip install azure-communication-rooms

Prerequisiti

Python 3.7 o versione successiva è necessario per usare questo pacchetto.
È necessaria una sottoscrizione di Azure per usare questo pacchetto.
Una risorsa di Servizi di comunicazione distribuita. È possibile usare il portale di Azure o il Azure PowerShell per configurarlo.

Inizializzazione client

Per inizializzare il client Rooms, è possibile usare la stringa di connessione per creare un'istanza.

from azure.communication.rooms import RoomsClient

client = RoomsClient.from_connection_string(conn_str='<connection_str>' )

Esempio

Parametri chiave

valid_from: oggetto datetime da cui inizierà la stanza esistente
valid_until: oggetto datetime dopo la fine della riunione della sala
participants: elenco di RoomParticipantelementi contenenti l'istanza di MRI di inviti alla stanza e facoltativo ParticipantRole. Se ParticipantRole non è specificato, sarà Attendee per impostazione predefinita. Tutti gli attributi precedenti sono facoltativi. Il servizio fornisce valori predefiniti di valid_until e valid_from se mancano. Il valore predefinito pervalid_from è l'ora corrente e il valore predefinito per valid_until è valid_from + 180 days.

Creare una stanza

Per creare una stanza, chiamare la create_room funzione da RoomsClient. Gli valid_fromargomenti , valid_untile participants sono tutti facoltativi.

from azure.core.exceptions import HttpResponseError
from datetime import datetime, timedelta
from azure.communication.rooms import (
    RoomsClient,
    RoomParticipant,
    ParticipantRole
)
from azure.communication.identity import CommunicationUserIdentifier

client = RoomsClient.from_connection_string(conn_str='<connection_str>')
valid_from = datetime.now()
valid_until = valid_from + relativedelta(months=+1)
participants = []
participants.append(RoomParticipant(CommunicationUserIdentifier("<ACS User MRI identity 1>")))
participants.append(RoomParticipant(CommunicationUserIdentifier("<ACS User MRI identity 2>"), ParticipantRole.CONSUMER))
participants.append(RoomParticipant(CommunicationUserIdentifier("<ACS User MRI identity 3>"), ParticipantRole.PRESENTER))

try:
    create_room_response = client.create_room(
        valid_from=valid_from,
        valid_until=valid_until,
        participants=participants
    )
except HttpResponseError as ex:
    print(ex)

Aggiornare una stanza

Le valid_from proprietà e valid_until di una stanza creata possono essere aggiornate chiamando la update_room funzione da RoomsClient.

try:
    update_room_response = client.update_room(
        room_id="id of the room to be updated",
        valid_from=datetime.now(),
        valid_until=valid_from + timedelta(weeks=4)
    )
except HttpResponseError as e:
    print('service responds error: {}'.format(e))

Ottenere una stanza

Una stanza creata può essere recuperata chiamando la funzione da RoomsClient e passando l'oggetto get_room associatoroom_id.

try:
    get_room_response = client.get_room(room_id="id of the room to get")
except HttpResponseError as ex:
    print(ex)

List rooms

Recuperare tutte le sale valide create con una risorsa ACS chiamando la list_rooms funzione da RoomsClient.

try:
    list_room_response = client.list_rooms()
except HttpResponseError as ex:
    print(ex)

Eliminare una stanza

Per eliminare una stanza, chiamare la delete_room funzione da RoomsClient.

try:
    client.delete_room(
        room_id="id of the room to be deleted")
except HttpResponseError as e:
    print('service responds error: {}'.format(e))

Aggiungere o aggiornare i partecipanti in una sala

Per inserire nuovi partecipanti o aggiornare i partecipanti esistenti, chiamare la add_or_update_participants funzione da RoomsClient.

participants = []
participants.append(RoomParticipant(CommunicationUserIdentifier("<ACS User MRI identity 1>")))
participants.append(RoomParticipant(CommunicationUserIdentifier("<ACS User MRI identity 2>"), ParticipantRole.ATTENDEE))
participants.append(RoomParticipant(CommunicationUserIdentifier("<ACS User MRI identity 3>"), ParticipantRole.CONSUMER))
try:
    response = client.add_or_update_participants(
        room_id="id of the room to be updated",
        participants=participants
    )
except HttpResponseError as e:
    print('service responds error: {}'.format(e))

Rimuovere i partecipanti

Rimuovere i partecipanti da una sala chiamando la remove_participants funzione da RoomsClient.

communication_identifiers = [CommunicationUserIdentifier("<ACS User MRI identity 2>")]

try:
    remove_participants_response = client.remove_participants(
        room_id=room_id,
        participants=communication_identifiers
    )
except HttpResponseError as ex:
    print(ex)

Elencare i partecipanti

Recuperare l'elenco dei partecipanti per una sala esistente facendo riferimento a room_id:

try:
    participants = self.rooms_client.list_participants(room_id)
except HttpResponseError as ex:
    print(ex)

Risoluzione dei problemi

Le operazioni delle sale genereranno un'eccezione se la richiesta al server ha esito negativo. Il client Rooms genererà eccezioni definite in Azure Core.

Passaggi successivi

Altro codice di esempio

Esaminare la directory esempi per esempi dettagliati su come usare questa libreria per creare e gestire le sale.

Commenti e suggerimenti

Se si verificano bug o suggerimenti, segnalare un problema nella sezione Problemi del progetto

Contributo

In questo progetto sono benvenuti i contributi e i suggerimenti. Per la maggior parte dei contenuti è necessario sottoscrivere un contratto di licenza di collaborazione (CLA, Contributor License Agreement) che stabilisce che l'utente ha il diritto di concedere, e di fatto concede a Microsoft i diritti d'uso del suo contributo. Per informazioni dettagliate, vedere https://cla.microsoft.com.

Quando si invia una richiesta pull, un bot CLA determina automaticamente se è necessario specificare un contratto CLA e completare la richiesta pull in modo appropriato (ad esempio con un'etichetta e un commento). Seguire le istruzioni specificate dal bot. È sufficiente eseguire questa operazione una sola volta per tutti i repository che usano il contratto CLA Microsoft.

Questo progetto ha adottato il Codice di comportamento di Microsoft per l'open source. Per altre informazioni, vedere Code of Conduct FAQ (Domande frequenti sul Codice di comportamento) oppure contattare opencode@microsoft.com per eventuali altre domande o commenti.

Condividi tramite