Share via

az communication chat thread

  • 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 thread 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 chat thread of a Communication Service resource.

Commands

Name Description Type Status
az communication chat thread create

Creates a chat thread.

 Extension Preview
az communication chat thread delete

Deletes a chat thread.

 Extension Preview
az communication chat thread list

Gets the list of chat threads of a user.

 Extension Preview
az communication chat thread update-topic

Updates the topic of a chat thread.

 Extension Preview

az communication chat thread create

Preview

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

Creates a chat thread.

az communication chat thread create --topic
                                    [--access-token]
                                    [--endpoint]
                                    [--idempotency-token]

Examples

Create chat thread

az communication chat thread create --topic "chat-topic"

Required Parameters

--topic

Chat topic.

Optional Parameters

--access-token

Communication access token. Environment variable: AZURE_COMMUNICATION_ACCESS_TOKEN.

--endpoint

Communication endpoint. Environment variable: AZURE_COMMUNICATION_ENDPOINT.

--idempotency-token

Idempotency token.

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 thread delete

Preview

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

Deletes a chat thread.

az communication chat thread delete --thread
                                    [--access-token]
                                    [--endpoint]
                                    [--yes]

Examples

Delete chat thread

az communication chat thread delete --thread "19:a-bcd=xyz"

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.

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

az communication chat thread list

Preview

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

Gets the list of chat threads of a user.

az communication chat thread list [--access-token]
                                  [--endpoint]
                                  [--start-time]

Examples

List chat threads

az communication chat thread list

Optional Parameters

--access-token

Communication access token. Environment variable: AZURE_COMMUNICATION_ACCESS_TOKEN.

--endpoint

Communication endpoint. Environment variable: AZURE_COMMUNICATION_ENDPOINT.

--start-time

Start time 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 thread update-topic

Preview

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

Updates the topic of a chat thread.

az communication chat thread update-topic --thread
                                          --topic
                                          [--access-token]
                                          [--endpoint]

Examples

Update chat thread topic

az communication chat thread update-topic --thread "19:a-bcd=xyz" --topic "New topic!"

Required Parameters

--thread -t

Thread id.

--topic

Chat topic.

Optional Parameters

--access-token

Communication access token. Environment variable: AZURE_COMMUNICATION_ACCESS_TOKEN.

--endpoint

Communication endpoint. Environment variable: AZURE_COMMUNICATION_ENDPOINT.

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.