az communication rooms
Note
This reference is part of the communication extension for the Azure CLI (version 2.59.0 or higher). The extension will automatically install the first time you run an az communication rooms command. Learn more about extensions.
Commands to interact with Azure Communication Services Rooms gateway.
Commands
Name | Description | Type | Status |
---|---|---|---|
az communication rooms create |
Create a new room. |
Extension | GA |
az communication rooms delete |
Delete an existing room. |
Extension | GA |
az communication rooms get |
Return attributes of an existing room. |
Extension | GA |
az communication rooms list |
List all active rooms belonging to a current Communication Service resource. |
Extension | GA |
az communication rooms participant |
Commands to manage participants of an existing room. |
Extension | GA |
az communication rooms participant add-or-update |
Add or update participants in a room. |
Extension | GA |
az communication rooms participant get |
Get participants of a room. |
Extension | GA |
az communication rooms participant remove |
Remove participants from a room. |
Extension | GA |
az communication rooms update |
Update attributes of an existing room. |
Extension | GA |
az communication rooms create
Create a new room.
az communication rooms create [--attendee-participants]
[--connection-string]
[--consumer-participants]
[--presenter-participants]
[--pstn-dial-out-enabled]
[--valid-from]
[--valid-until]
Examples
Create a room with default parameters
az communication rooms create
Create a room with valid-from and valid-until date/times
az communication rooms create --valid-from "2022-07-14T10:21" --valid-until "2022-08-14T10:21"
Create a room with valid-from, valid-until date/times and 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"
Create a room with a list of participants with presenter role
az communication rooms create --presenter-participants "8:acs:xxxxxx" "8:acs:xxxxxx"
Create a room with a list of participants with attendee role
az communication rooms create --attendee-participants "8:acs:xxxxxx" "8:acs:xxxxxx"
Create a room with a list of participants with presenter and consumer roles
az communication rooms create --presenter-participants "8:acs:xxxxxx" "8:acs:xxxxxx" --consumer-participants "8:acs:xxxxxx" "8:acs:xxxxxx"
Optional Parameters
Collection of identities to be invited to the room as attendee. Optional.
Communication connection string. Environment variable: AZURE_COMMUNICATION_CONNECTION_STRING.
Collection of identities to be invited to the room as consumer. Optional.
Collection of identities to be invited to the room as presenter. Optional.
Set this flag to true if, at the time of the call, dial out to a PSTN number is enabled in a particular room. By default, this flag is set to false. Optional.
The timestamp from when the room is open for joining, in in ISO8601 format, ex: 2023-03-31T10:21. Optional.
The timestamp from when the room can no longer be joined, in ISO8601 format, ex: 2023-06-31T10:21. Optional.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az communication rooms delete
Delete an existing room.
az communication rooms delete --room
[--connection-string]
[--yes]
Examples
Delete an existing room
az communication rooms delete --room "12345678901234567"
Required Parameters
Room Id.
Optional Parameters
Communication connection string. Environment variable: AZURE_COMMUNICATION_CONNECTION_STRING.
Do not prompt for confirmation.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az communication rooms get
Return attributes of an existing room.
az communication rooms get --room
[--connection-string]
Examples
Get room
az communication rooms get --room "12345678901234567"
Required Parameters
Room Id.
Optional Parameters
Communication connection string. Environment variable: AZURE_COMMUNICATION_CONNECTION_STRING.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az communication rooms list
List all active rooms belonging to a current Communication Service resource.
az communication rooms list [--connection-string]
Examples
List all active rooms
az communication rooms list
Optional Parameters
Communication connection string. Environment variable: AZURE_COMMUNICATION_CONNECTION_STRING.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az communication rooms update
Update attributes of an existing room.
az communication rooms update --room
[--connection-string]
[--pstn-dial-out-enabled]
[--valid-from]
[--valid-until]
Examples
Update a room's valid-from and valid-until properties
az communication rooms update --room "12345678901234567" --valid-from "2022-07-14T10:21" --valid-until "2022-08-14T10:21"
Required Parameters
Room Id.
Optional Parameters
Communication connection string. Environment variable: AZURE_COMMUNICATION_CONNECTION_STRING.
Set this flag to true if, at the time of the call, dial out to a PSTN number is enabled in a particular room. By default, this flag is set to false. Optional.
The timestamp from when the room is open for joining, in in ISO8601 format, ex: 2023-03-31T10:21. Should be used together with --valid-until. Optional.
The timestamp from when the room can no longer be joined, in ISO8601 format, ex: 2023-06-31T10:21. Should be used together with --valid-from. Optional.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.