Udostępnij przez

az communication rooms

Note

Ta dokumentacja jest częścią rozszerzenia komunikacji dla interfejsu wiersza polecenia platformy Azure (wersja 2.67.0 lub nowsza). Rozszerzenie automatycznie zainstaluje polecenie az communication rooms. Dowiedz się więcej o rozszerzeniach.

Polecenia umożliwiające interakcję z bramą usługi Azure Communication Services Rooms.

Polecenia

Nazwa Opis Typ Stan
az communication rooms create

Utwórz nowy pokój.

 Extension ogólna dostępność
az communication rooms delete

Usuń istniejący pokój.

 Extension ogólna dostępność
az communication rooms get

Zwraca atrybuty istniejącego pokoju.

 Extension ogólna dostępność
az communication rooms list

Wyświetl listę wszystkich aktywnych pomieszczeń należących do bieżącego zasobu usługi komunikacyjnej.

 Extension ogólna dostępność
az communication rooms participant

Polecenia do zarządzania uczestnikami istniejącego pokoju.

 Extension ogólna dostępność
az communication rooms participant add-or-update

Dodaj lub zaktualizuj uczestników w pokoju.

 Extension ogólna dostępność
az communication rooms participant get

Pobierz uczestników pokoju.

 Extension ogólna dostępność
az communication rooms participant remove

Usuń uczestników z pokoju.

 Extension ogólna dostępność
az communication rooms update

Aktualizowanie atrybutów istniejącego pokoju.

 Extension ogólna dostępność

az communication rooms create

Utwórz nowy pokój.

az communication rooms create [--attendee-participants --attendees]
                              [--collaborator-participants --collaborators]
                              [--connection-string]
                              [--consumer-participants --consumers]
                              [--presenter-participants --presenters]
                              [--pstn-dial-out-enabled]
                              [--valid-from]
                              [--valid-until]

Przykłady

Tworzenie pokoju z parametrami domyślnymi

az communication rooms create

Tworzenie pokoju z prawidłowym i prawidłowym datą/godziną

az communication rooms create --valid-from "2022-07-14T10:21" --valid-until "2022-08-14T10:21"

Utwórz pokój z prawidłowym, prawidłowym do daty/godziny i włączoną funkcją pstn-dial-out-enabled

az communication rooms create --valid-from "2022-07-14T10:21" --valid-until "2022-08-14T10:21" --pstn-dial-out-enabled "True"

Tworzenie pokoju z listą uczestników z rolą prezentera

az communication rooms create --presenter-participants "8:acs:xxxxxx" "8:acs:xxxxxx"

Tworzenie pokoju z listą uczestników z rolą uczestnika

az communication rooms create --attendee-participants "8:acs:xxxxxx" "8:acs:xxxxxx"

Tworzenie pokoju z listą uczestników z rolami prezenterów i konsumentów

az communication rooms create --presenter-participants "8:acs:xxxxxx" "8:acs:xxxxxx" --consumer-participants "8:acs:xxxxxx" "8:acs:xxxxxx"

Tworzenie pokoju z listą uczestników z rolami uczestników i współpracowników

az communication rooms create --attendee-participants "8:acs:xxxxxx" "8:acs:xxxxxx" --collaborator-participants "8:acs:xxxxxx" "8:acs:xxxxxx"

Parametry opcjonalne

Poniższe parametry są opcjonalne, ale w zależności od kontekstu co najmniej jeden może być wymagany do pomyślnego wykonania polecenia.

--attendee-participants --attendees

Kolekcja tożsamości, które mają zostać zaproszone do pokoju jako uczestnik. Optional.

--collaborator-participants --collaborators

Kolekcja tożsamości, które mają zostać zaproszone do pokoju jako współpracownik. Optional.

--connection-string

Parametry połączenia komunikacyjnego. Zmienna środowiskowa: AZURE_COMMUNICATION_CONNECTION_STRING.

Właściwość Wartość
Grupa parametrów: Communication Arguments
--consumer-participants --consumers

Kolekcja tożsamości, które mają zostać zaproszone do pokoju jako użytkownik. Optional.

--presenter-participants --presenters

Kolekcja tożsamości, które mają zostać zaproszone do pokoju jako prezenter. Optional.

--pstn-dial-out-enabled

Ustaw tę flagę na true, jeśli w momencie połączenia wybierz numer PSTN jest włączony w określonym pomieszczeniu. Domyślnie ta flaga ma wartość false. Optional.

--valid-from

Sygnatura czasowa od momentu otwarcia pokoju do przyłączenia w formacie ISO8601, np. 2023-03-31T10:21. Optional.

--valid-until

Sygnatura czasowa, z kiedy nie można już dołączyć pomieszczenia w formacie ISO8601, np. 2023-06-31T10:21. Optional.

Parametry globalne
--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False
--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

Właściwość Wartość
Domyślna wartość: False
--output -o

Format danych wyjściowych.

Właściwość Wartość
Domyślna wartość: json
Dopuszczalne wartości: json, jsonc, none, table, tsv, yaml, yamlc
--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False

az communication rooms delete

Usuń istniejący pokój.

az communication rooms delete --room
                              [--connection-string]
                              [--yes]

Przykłady

Usuwanie istniejącego pokoju

az communication rooms delete --room "12345678901234567"

Parametry wymagane

--room

Identyfikator pokoju.

Parametry opcjonalne

Poniższe parametry są opcjonalne, ale w zależności od kontekstu co najmniej jeden może być wymagany do pomyślnego wykonania polecenia.

--connection-string

Parametry połączenia komunikacyjnego. Zmienna środowiskowa: AZURE_COMMUNICATION_CONNECTION_STRING.

Właściwość Wartość
Grupa parametrów: Communication Arguments
--yes -y

Nie monituj o potwierdzenie.

Właściwość Wartość
Domyślna wartość: False
Parametry globalne
--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False
--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

Właściwość Wartość
Domyślna wartość: False
--output -o

Format danych wyjściowych.

Właściwość Wartość
Domyślna wartość: json
Dopuszczalne wartości: json, jsonc, none, table, tsv, yaml, yamlc
--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False

az communication rooms get

Zwraca atrybuty istniejącego pokoju.

az communication rooms get --room
                           [--connection-string]

Przykłady

Pobierz pokój

az communication rooms get --room "12345678901234567"

Parametry wymagane

--room

Identyfikator pokoju.

Parametry opcjonalne

Poniższe parametry są opcjonalne, ale w zależności od kontekstu co najmniej jeden może być wymagany do pomyślnego wykonania polecenia.

--connection-string

Parametry połączenia komunikacyjnego. Zmienna środowiskowa: AZURE_COMMUNICATION_CONNECTION_STRING.

Właściwość Wartość
Grupa parametrów: Communication Arguments
Parametry globalne
--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False
--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

Właściwość Wartość
Domyślna wartość: False
--output -o

Format danych wyjściowych.

Właściwość Wartość
Domyślna wartość: json
Dopuszczalne wartości: json, jsonc, none, table, tsv, yaml, yamlc
--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False

az communication rooms list

Wyświetl listę wszystkich aktywnych pomieszczeń należących do bieżącego zasobu usługi komunikacyjnej.

az communication rooms list [--connection-string]

Przykłady

Wyświetl listę wszystkich aktywnych pomieszczeń

az communication rooms list

Parametry opcjonalne

Poniższe parametry są opcjonalne, ale w zależności od kontekstu co najmniej jeden może być wymagany do pomyślnego wykonania polecenia.

--connection-string

Parametry połączenia komunikacyjnego. Zmienna środowiskowa: AZURE_COMMUNICATION_CONNECTION_STRING.

Właściwość Wartość
Grupa parametrów: Communication Arguments
Parametry globalne
--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False
--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

Właściwość Wartość
Domyślna wartość: False
--output -o

Format danych wyjściowych.

Właściwość Wartość
Domyślna wartość: json
Dopuszczalne wartości: json, jsonc, none, table, tsv, yaml, yamlc
--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False

az communication rooms update

Aktualizowanie atrybutów istniejącego pokoju.

az communication rooms update --room
                              [--connection-string]
                              [--pstn-dial-out-enabled]
                              [--valid-from]
                              [--valid-until]

Przykłady

Aktualizowanie prawidłowych i prawidłowych właściwości pokoju

az communication rooms update --room "12345678901234567" --valid-from "2022-07-14T10:21" --valid-until "2022-08-14T10:21"

Parametry wymagane

--room

Identyfikator pokoju.

Parametry opcjonalne

Poniższe parametry są opcjonalne, ale w zależności od kontekstu co najmniej jeden może być wymagany do pomyślnego wykonania polecenia.

--connection-string

Parametry połączenia komunikacyjnego. Zmienna środowiskowa: AZURE_COMMUNICATION_CONNECTION_STRING.

Właściwość Wartość
Grupa parametrów: Communication Arguments
--pstn-dial-out-enabled

Ustaw tę flagę na true, jeśli w momencie połączenia wybierz numer PSTN jest włączony w określonym pomieszczeniu. Domyślnie ta flaga ma wartość false. Optional.

--valid-from

Sygnatura czasowa od momentu otwarcia pokoju do przyłączenia w formacie ISO8601, np. 2023-03-31T10:21. Należy używać razem z --valid-until. Optional.

--valid-until

Sygnatura czasowa, z kiedy nie można już dołączyć pomieszczenia w formacie ISO8601, np. 2023-06-31T10:21. Należy używać razem z --valid-from. Optional.

Parametry globalne
--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False
--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

Właściwość Wartość
Domyślna wartość: False
--output -o

Format danych wyjściowych.

Właściwość Wartość
Domyślna wartość: json
Dopuszczalne wartości: json, jsonc, none, table, tsv, yaml, yamlc
--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False