Поделиться через

az communication rooms

Note

Эта ссылка является частью расширения связи для Azure CLI (версия 2.67.0 или более поздней). Расширение будет автоматически устанавливаться при первом запуске команды az communication rooms. Подробнее о расширениях.

Команды для взаимодействия с шлюзом комнат Служб коммуникации Azure.

Команды

Имя Описание Тип Состояние
az communication rooms create

Создайте новую комнату.

 Extension GA
az communication rooms delete

Удаление существующей комнаты.

 Extension GA
az communication rooms get

Возвращайте атрибуты существующей комнаты.

 Extension GA
az communication rooms list

Перечислить все активные комнаты, принадлежащие текущему ресурсу службы коммуникации.

 Extension GA
az communication rooms participant

Команды для управления участниками существующей комнаты.

 Extension GA
az communication rooms participant add-or-update

Добавьте или обновите участников в комнате.

 Extension GA
az communication rooms participant get

Получение участников комнаты.

 Extension GA
az communication rooms participant remove

Удалите участников из комнаты.

 Extension GA
az communication rooms update

Обновление атрибутов существующей комнаты.

 Extension GA

az communication rooms create

Создайте новую комнату.

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]

Примеры

Создание комнаты с параметрами по умолчанию

az communication rooms create

Создание комнаты с допустимой и допустимой датой и временем

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

Создание комнаты с допустимой, допустимой до даты и времени и тсоп-исходящих номеров

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

Создание комнаты со списком участников с ролью докладчика

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

Создание комнаты со списком участников с ролью участника

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

Создание комнаты со списком участников с ролями докладчика и потребителей

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

Создание комнаты со списком участников с ролями участников и участников совместной работы

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

Необязательные параметры

Следующие параметры являются необязательными, но в зависимости от контекста один или несколько могут потребоваться для успешного выполнения команды.

--attendee-participants --attendees

Коллекция удостоверений, которые будут приглашены в комнату в качестве участника. Optional.

--collaborator-participants --collaborators

Коллекция удостоверений, которые будут приглашены в комнату в качестве участника совместной работы. Optional.

--connection-string

Строка подключения связи. Переменная среды: AZURE_COMMUNICATION_CONNECTION_STRING.

Свойство Значение
Группа параметров: Communication Arguments
--consumer-participants --consumers

Коллекция удостоверений, которые будут приглашены в комнату в качестве потребителя. Optional.

--presenter-participants --presenters

Коллекция удостоверений, которые будут приглашены в комнату в качестве докладчика. Optional.

--pstn-dial-out-enabled

Установите для этого флага значение true, если во время вызова в определенной комнате включен номер ТСОП. По умолчанию этот флаг установлен в значение false. Optional.

--valid-from

Метка времени, от момента открытия комнаты для присоединения, в ISO8601 формате, например 2023-03-31T10:21. Optional.

--valid-until

Метка времени от момента, когда комната больше не может быть присоединена, в ISO8601 формате, например 2023-06-31T10:21. Optional.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Default value: False
--output -o

Формат вывода.

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство Значение
Default value: False

az communication rooms delete

Удаление существующей комнаты.

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

Примеры

Удаление существующей комнаты

az communication rooms delete --room "12345678901234567"

Обязательные параметры

--room

Идентификатор комнаты.

Необязательные параметры

Следующие параметры являются необязательными, но в зависимости от контекста один или несколько могут потребоваться для успешного выполнения команды.

--connection-string

Строка подключения связи. Переменная среды: AZURE_COMMUNICATION_CONNECTION_STRING.

Свойство Значение
Группа параметров: Communication Arguments
--yes -y

Не запрашивать подтверждение.

Свойство Значение
Default value: False
Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Default value: False
--output -o

Формат вывода.

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство Значение
Default value: False

az communication rooms get

Возвращайте атрибуты существующей комнаты.

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

Примеры

Получение комнаты

az communication rooms get --room "12345678901234567"

Обязательные параметры

--room

Идентификатор комнаты.

Необязательные параметры

Следующие параметры являются необязательными, но в зависимости от контекста один или несколько могут потребоваться для успешного выполнения команды.

--connection-string

Строка подключения связи. Переменная среды: AZURE_COMMUNICATION_CONNECTION_STRING.

Свойство Значение
Группа параметров: Communication Arguments
Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Default value: False
--output -o

Формат вывода.

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство Значение
Default value: False

az communication rooms list

Перечислить все активные комнаты, принадлежащие текущему ресурсу службы коммуникации.

az communication rooms list [--connection-string]

Примеры

Вывод списка всех активных комнат

az communication rooms list

Необязательные параметры

Следующие параметры являются необязательными, но в зависимости от контекста один или несколько могут потребоваться для успешного выполнения команды.

--connection-string

Строка подключения связи. Переменная среды: AZURE_COMMUNICATION_CONNECTION_STRING.

Свойство Значение
Группа параметров: Communication Arguments
Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Default value: False
--output -o

Формат вывода.

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство Значение
Default value: False

az communication rooms update

Обновление атрибутов существующей комнаты.

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

Примеры

Обновление допустимых и допустимых свойств комнаты

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

Обязательные параметры

--room

Идентификатор комнаты.

Необязательные параметры

Следующие параметры являются необязательными, но в зависимости от контекста один или несколько могут потребоваться для успешного выполнения команды.

--connection-string

Строка подключения связи. Переменная среды: AZURE_COMMUNICATION_CONNECTION_STRING.

Свойство Значение
Группа параметров: Communication Arguments
--pstn-dial-out-enabled

Установите для этого флага значение true, если во время вызова в определенной комнате включен номер ТСОП. По умолчанию этот флаг установлен в значение false. Optional.

--valid-from

Метка времени, от момента открытия комнаты для присоединения, в ISO8601 формате, например 2023-03-31T10:21. Следует использовать вместе с --valid-until. Optional.

--valid-until

Метка времени от момента, когда комната больше не может быть присоединена, в ISO8601 формате, например 2023-06-31T10:21. Следует использовать вместе с --valid-from. Optional.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Default value: False
--output -o

Формат вывода.

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство Значение
Default value: False