Share via

az communication chat participant

  • Preview
  • Reference

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

Command group 'communication chat' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Commands to manage participants in a chat thread of a Communication Service resource.

Commands

Name Description Type Status
az communication chat participant add

Adds a participant to a chat thread.

 Extension Preview
az communication chat participant list

Gets the participants of a chat thread.

 Extension Preview
az communication chat participant remove

Removes a participant from a chat thread.

 Extension Preview

az communication chat participant add

Preview

Command group 'communication chat participant' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Adds a participant to a chat thread.

az communication chat participant add --thread
                                      --user
                                      [--access-token]
                                      [--display-name]
                                      [--endpoint]
                                      [--start-time]

Examples

Add participant

az communication chat participant add --thread "19:a-bcd=xyz" --user "8:acs:xxxxxx" --display-name "John Doe" --start-time "2022-07-14T10:21"

Required Parameters

--thread -t

Thread id.

--user

Chat participant identifier.

Optional Parameters

--access-token

Communication access token. Environment variable: AZURE_COMMUNICATION_ACCESS_TOKEN.

--display-name

Chat participant display name.

--endpoint

Communication endpoint. Environment variable: AZURE_COMMUNICATION_ENDPOINT.

--start-time

Start time to share history in ISO8601 format, ex: 2022-07-14T10:21.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az communication chat participant list

Preview

Command group 'communication chat participant' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Gets the participants of a chat thread.

az communication chat participant list --thread
                                       [--access-token]
                                       [--endpoint]
                                       [--skip]

Examples

List participants

az communication chat participant list --thread "19:a-bcd=xyz" --skip "4"

Required Parameters

--thread -t

Thread id.

Optional Parameters

--access-token

Communication access token. Environment variable: AZURE_COMMUNICATION_ACCESS_TOKEN.

--endpoint

Communication endpoint. Environment variable: AZURE_COMMUNICATION_ENDPOINT.

--skip

Number of participants to skip.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az communication chat participant remove

Preview

Command group 'communication chat participant' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Removes a participant from a chat thread.

az communication chat participant remove --thread
                                         --user
                                         [--access-token]
                                         [--endpoint]
                                         [--yes]

Examples

Remove participant

az communication chat participant remove --thread "19:a-bcd=xyz" --user "8:acs:xxxxxx"

Required Parameters

--thread -t

Thread id.

--user

Chat participant identifier.

Optional Parameters

--access-token

Communication access token. Environment variable: AZURE_COMMUNICATION_ACCESS_TOKEN.

--endpoint

Communication endpoint. Environment variable: AZURE_COMMUNICATION_ENDPOINT.

--yes -y

Do not prompt for confirmation.

Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.