Jaa

az communication chat message

  • Preview

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

Commands

Name Description Type Status
az communication chat message delete

Deletes a message from a chat thread by id.

 Extension Preview
az communication chat message get

Gets a message from a chat thread by id.

 Extension Preview
az communication chat message list

Gets list of messages from a chat thread.

 Extension Preview
az communication chat message receipt

Commands to manage message read-receipts in a chat thread of a Communication Service resource.

 Extension Preview
az communication chat message receipt list

Gets read receipts of a chat thread.

 Extension Preview
az communication chat message receipt send

Posts a read receipt event to a chat thread, on behalf of a user.

 Extension Preview
az communication chat message send

Sends a message to a chat thread.

 Extension Preview
az communication chat message update

Updates a message.

 Extension Preview

az communication chat message delete

Preview

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

Deletes a message from a chat thread by id.

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

Examples

Delete message

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

Required Parameters

--message-id

Message id.

--thread -t

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

--access-token

Communication access token. Environment variable: AZURE_COMMUNICATION_ACCESS_TOKEN.

Property Value
Parameter group: Communication Arguments
--endpoint

Communication endpoint. Environment variable: AZURE_COMMUNICATION_ENDPOINT.

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 chat message get

Preview

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

Gets a message from a chat thread by id.

az communication chat message get --message-id
                                  --thread
                                  [--access-token]
                                  [--endpoint]

Examples

Get message

az communication chat message get --thread "19:a-bcd=xyz" --message-id "12345678"

Required Parameters

--message-id

Message id.

--thread -t

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

--access-token

Communication access token. Environment variable: AZURE_COMMUNICATION_ACCESS_TOKEN.

Property Value
Parameter group: Communication Arguments
--endpoint

Communication endpoint. Environment variable: AZURE_COMMUNICATION_ENDPOINT.

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 chat message list

Preview

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

Gets list of messages from a chat thread.

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

Examples

List messages

az communication chat message list --thread "19:a-bcd=xyz" --start-time "2022-07-14T10:21"

Required Parameters

--thread -t

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

--access-token

Communication access token. Environment variable: AZURE_COMMUNICATION_ACCESS_TOKEN.

Property Value
Parameter group: Communication Arguments
--endpoint

Communication endpoint. Environment variable: AZURE_COMMUNICATION_ENDPOINT.

Property Value
Parameter group: Communication Arguments
--start-time

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

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 chat message send

Preview

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

Sends a message to a chat thread.

az communication chat message send --content
                                   --thread
                                   [--access-token]
                                   [--display-name]
                                   [--endpoint]
                                   [--message-type]

Examples

Send message

az communication chat message send --thread "19:a-bcd=xyz" --display-name "John Doe" --content "Hello there!" --message-type "text"

Required Parameters

--content

Chat message content.

--thread -t

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

--access-token

Communication access token. Environment variable: AZURE_COMMUNICATION_ACCESS_TOKEN.

Property Value
Parameter group: Communication Arguments
--display-name

Senders display name.

--endpoint

Communication endpoint. Environment variable: AZURE_COMMUNICATION_ENDPOINT.

Property Value
Parameter group: Communication Arguments
--message-type

Content type, can be text or html.

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 chat message update

Preview

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

Updates a message.

az communication chat message update --content
                                     --message-id
                                     --thread
                                     [--access-token]
                                     [--endpoint]

Examples

Update message

az communication chat message update --thread "19:a-bcd=xyz" --message-id "12345678" --content "Hello, there!"

Required Parameters

--content

Chat message content.

--message-id

Message id.

--thread -t

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

--access-token

Communication access token. Environment variable: AZURE_COMMUNICATION_ACCESS_TOKEN.

Property Value
Parameter group: Communication Arguments
--endpoint

Communication endpoint. Environment variable: AZURE_COMMUNICATION_ENDPOINT.

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