Share via

az communication rooms

Note

This reference is part of the communication extension for the Azure CLI (version 2.67.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 --attendees]
                              [--collaborator-participants --collaborators]
                              [--connection-string]
                              [--consumer-participants --consumers]
                              [--presenter-participants --presenters]
                              [--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"

Create a room with a list of participants with attendee and collaborator roles

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--attendee-participants --attendees

Collection of identities to be invited to the room as attendee. Optional.

--collaborator-participants --collaborators

Collection of identities to be invited to the room as collaborator. Optional.

--connection-string

Communication connection string. Environment variable: AZURE_COMMUNICATION_CONNECTION_STRING.

Property Value
Parameter group: Communication Arguments
--consumer-participants --consumers

Collection of identities to be invited to the room as consumer. Optional.

--presenter-participants --presenters

Collection of identities to be invited to the room as presenter. Optional.

--pstn-dial-out-enabled

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.

--valid-from

The timestamp from when the room is open for joining, in in ISO8601 format, ex: 2023-03-31T10:21. Optional.

--valid-until

The timestamp from when the room can no longer be joined, in ISO8601 format, ex: 2023-06-31T10:21. Optional.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

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

Room Id.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--connection-string

Communication connection string. Environment variable: AZURE_COMMUNICATION_CONNECTION_STRING.

Property Value
Parameter group: Communication Arguments
--yes -y

Do not prompt for confirmation.

Property Value
Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

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

Room Id.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--connection-string

Communication connection string. Environment variable: AZURE_COMMUNICATION_CONNECTION_STRING.

Property Value
Parameter group: Communication Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--connection-string

Communication connection string. Environment variable: AZURE_COMMUNICATION_CONNECTION_STRING.

Property Value
Parameter group: Communication Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

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

Room Id.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--connection-string

Communication connection string. Environment variable: AZURE_COMMUNICATION_CONNECTION_STRING.

Property Value
Parameter group: Communication Arguments
--pstn-dial-out-enabled

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.

--valid-from

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.

--valid-until

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
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False