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:

get

Successfully retrieved communication details.

Name	Datatype	Description
id	string	Id of the resource.
name	string	Name of the resource.
properties	object	Properties of the resource.
type	string	Type of the resource 'Microsoft.Support/communications'.

list

Successfully retrieved communications for a support ticket.

Name	Datatype	Description
id	string	Id of the resource.
name	string	Name of the resource.
properties	object	Properties of the resource.
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
get	select	supportTicketName, communicationName, subscriptionId		Returns communication details for a support ticket.
list	select	supportTicketName, subscriptionId	$top, $filter	Lists all communications (attachments not included) for a support ticket. </br> 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	supportTicketName, communicationName, subscriptionId		Adds a new customer communication to an Azure support ticket.
check_name_availability	exec	supportTicketName, subscriptionId, name, type		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.

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
communicationName	string	Communication name.
subscriptionId	string	Azure subscription Id.
supportTicketName	string	Support ticket name.
$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.
$top	integer (int32)	The number of values to return in the collection. Default is 10 and max is 10.

SELECT examples

get

Returns communication details for a support ticket.

SELECT
id,
name,
properties,
type
FROM azure.support.communications
WHERE supportTicketName = '{{ supportTicketName }}' -- required
AND communicationName = '{{ communicationName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list

Lists all communications (attachments not included) for a support ticket.
</br> 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,
properties,
type
FROM azure.support.communications
WHERE supportTicketName = '{{ supportTicketName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- 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 (
data__properties,
supportTicketName,
communicationName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ supportTicketName }}',
'{{ communicationName }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: communications
  props:
    - name: supportTicketName
      value: string
      description: Required parameter for the communications resource.
    - name: communicationName
      value: string
      description: Required parameter for the communications resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the communications resource.
    - name: properties
      value: object
      description: |
        Properties of the resource.

Lifecycle Methods

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.

EXEC azure.support.communications.check_name_availability 
@supportTicketName='{{ supportTicketName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"name": "{{ name }}", 
"type": "{{ type }}"
}'
;