Share via

az communication rooms participant

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 participant command. Learn more about extensions.

Commands to manage participants of an existing room.

Commands

Name Description Type Status
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 participant add-or-update

Add or update participants in a room.

az communication rooms participant add-or-update --room
                                                 [--acquire-policy-token]
                                                 [--attendee-participants --attendees]
                                                 [--change-reference]
                                                 [--collaborator-participants --collaborators]
                                                 [--connection-string]
                                                 [--consumer-participants --consumers]
                                                 [--presenter-participants --presenters]

Examples

Add a presenter participant to a room and update an attendee participant in a room

az communication rooms participant add-or-update --room "12345678901234567" --presenter-participants "8:acs:xxxxxx" "8:acs:xxxxxx" --attendee-participants "8:acs:xxxxxx" "8:acs:xxxxxx"

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.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--attendee-participants --attendees

Collection of identities to be added to the room as attendee.

--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--collaborator-participants --collaborators

Collection of identities to be added to the room as collaborator.

--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 added to the room as consumer.

--presenter-participants --presenters

Collection of identities to be added to the room as presenter.

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 participant get

Get participants of a room.

az communication rooms participant get --room
                                       [--acquire-policy-token]
                                       [--change-reference]
                                       [--connection-string]

Examples

Get room's participants

az communication rooms participant 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.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--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 participant remove

Remove participants from a room.

az communication rooms participant remove --participants
                                          --room
                                          [--acquire-policy-token]
                                          [--change-reference]
                                          [--connection-string]
                                          [--yes]

Examples

Remove room participants

az communication rooms participant remove --room "12345678901234567" --participants "8:acs:xxxxxx" "8:acs:xxxxxx" "8:acs:xxxxxx"

Required Parameters

--participants

Collection of identities that will be removed from the room.

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--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