communications

Creates, updates, deletes, gets or lists a communications resource.

Overview

Name	communications
Type	Resource
Id	azure.support.communications

Fields

The following fields are returned by SELECT queries:

check_name_availability

Name	Datatype	Description
message	string	The detailed error message describing why the name is not available.
nameAvailable	boolean	Indicates whether the name is available.
reason	string	The reason why the name is not available.

get

Name	Datatype	Description
id	string	Id of the resource.
name	string	Name of the resource.
body	string	Body of the communication. Required.
communicationDirection	string	Direction of communication. Known values are: "inbound" and "outbound".
communicationType	string	Communication type. Known values are: "web" and "phone".
createdDate	string (date-time)	Time in UTC (ISO 8601 format) when the communication was created.
sender	string	Email address of the sender. This property is required if called by a service principal.
subject	string	Subject of the communication. Required.
type	string	Type of the resource 'Microsoft.Support/communications'.

list

Name	Datatype	Description
id	string	Id of the resource.
name	string	Name of the resource.
body	string	Body of the communication. Required.
communicationDirection	string	Direction of communication. Known values are: "inbound" and "outbound".
communicationType	string	Communication type. Known values are: "web" and "phone".
createdDate	string (date-time)	Time in UTC (ISO 8601 format) when the communication was created.
sender	string	Email address of the sender. This property is required if called by a service principal.
subject	string	Subject of the communication. Required.
type	string	Type of the resource 'Microsoft.Support/communications'.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
check_name_availability	select	support_ticket_name, subscription_id		Check the availability of a resource name. This API should be used to check the uniqueness of the name for adding a new communication to the support ticket.
get	select	support_ticket_name, communication_name, subscription_id		Returns communication details for a support ticket.
list	select	support_ticket_name, subscription_id	$top, $filter	Lists 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.
create	insert	support_ticket_name, communication_name, subscription_id, properties		Adds a new customer communication to an Azure support ticket.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
communication_name	string	Communication name. Required.
subscription_id	string
support_ticket_name	string	Support ticket name. Required.
$filter	string	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. Default value is None.
$top	integer	The number of values to return in the collection. Default is 10 and max is 10. Default value is None.

SELECT examples

check_name_availability

Check the availability of a resource name. This API should be used to check the uniqueness of the name for adding a new communication to the support ticket.

SELECT
message,
nameAvailable,
reason
FROM azure.support.communications
WHERE support_ticket_name = '{{ support_ticket_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get

Returns communication details for a support ticket.

SELECT
id,
name,
body,
communicationDirection,
communicationType,
createdDate,
sender,
subject,
type
FROM azure.support.communications
WHERE support_ticket_name = '{{ support_ticket_name }}' -- required
AND communication_name = '{{ communication_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

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

SELECT
id,
name,
body,
communicationDirection,
communicationType,
createdDate,
sender,
subject,
type
FROM azure.support.communications
WHERE support_ticket_name = '{{ support_ticket_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $top = '{{ $top }}'
AND $filter = '{{ $filter }}'
;

INSERT examples

create

Adds a new customer communication to an Azure support ticket.

INSERT INTO azure.support.communications (
properties,
support_ticket_name,
communication_name,
subscription_id
)
SELECT 
'{{ properties }}' /* required */,
'{{ support_ticket_name }}',
'{{ communication_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: communications
props:
  - name: support_ticket_name
    value: "{{ support_ticket_name }}"
    description: Required parameter for the communications resource.
  - name: communication_name
    value: "{{ communication_name }}"
    description: Required parameter for the communications resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the communications resource.
  - name: properties
    value:
      sender: "{{ sender }}"
      subject: "{{ subject }}"
      body: "{{ body }}"