Share via

az support in-subscription communication

  • Reference

Note

This reference is part of the support extension for the Azure CLI (version 2.57.0 or higher). The extension will automatically install the first time you run an az support in-subscription communication command. Learn more about extensions.

Manage support ticket communications.

Commands

Name Description Type Status
az support in-subscription communication create

Adds a new customer communication to an Azure support ticket.

 Extension GA
az support in-subscription communication list

List all communications (attachments not included) for a support ticket.

You can also filter support ticket communications by CreatedDate or CommunicationType using the $filter parameter. The only type of communication supported today is Web. Output will be a paged result with nextLink, using which you can retrieve the next set of Communication results.

Support ticket data is available for 18 months after ticket creation. If a ticket was created more than 18 months ago, a request for data might cause an error.

 Extension GA
az support in-subscription communication show

Get communication details for a support ticket.

 Extension GA

az support in-subscription communication create

Adds a new customer communication to an Azure support ticket.

az support in-subscription communication create --communication-body
                                                --communication-name
                                                --communication-subject
                                                --ticket-name
                                                [--communication-sender]
                                                [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]

Examples

Adds a new customer communication to an Azure support ticket.

az support in-subscription communication create  --ticket-name "TestTicketName "--communication-name "TestTicketCommunicationName" --communication-body "TicketCommunicationBody" --communication-subject "TicketCommunicationSubject"

Required Parameters

--communication-body

Body of the communication.

--communication-name

Communication name.

--communication-subject

Subject of the communication.

--ticket-name

Support ticket name.

Optional Parameters

--communication-sender

Email address of the sender. This property is required if called by a service principal.

--no-wait

Do not wait for the long-running operation to finish.

accepted values: 0, 1, f, false, n, no, t, true, y, yes
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 support in-subscription communication list

List all communications (attachments not included) for a support ticket.

You can also filter support ticket communications by CreatedDate or CommunicationType using the $filter parameter. The only type of communication supported today is Web. Output will be a paged result with nextLink, using which you can retrieve the next set of Communication results.

Support ticket data is available for 18 months after ticket creation. If a ticket was created more than 18 months ago, a request for data might cause an error.

az support in-subscription communication list --ticket-name
                                              [--filter]
                                              [--max-items]
                                              [--next-token]

Examples

List web communication created on or after a specific date for a subscription support ticket.

az support in-subscription communication list --ticket-name "TestTicketName" --filter "CreatedDate ge 2024-01-01"

Required Parameters

--ticket-name

Support ticket name.

Optional Parameters

--filter

The filter to apply on the operation. You can filter by communicationType and createdDate properties. CommunicationType supports Equals ('eq') operator and createdDate supports Greater Than ('gt') and Greater Than or Equals ('ge') operators. You may combine the CommunicationType and CreatedDate filters by Logical And ('and') operator.

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

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 support in-subscription communication show

Get communication details for a support ticket.

az support in-subscription communication show --communication-name
                                              --ticket-name

Examples

Get communication details for a subscription support ticket.

az support in-subscription communication show --ticket-name "TestTicketName" --communication-name "TestTicketCommunicationName"

Required Parameters

--communication-name

Communication name.

--ticket-name

Support ticket name.

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.