communications

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

Overview

Name	communications
Type	Resource
Id	azure.support.communications

Fields

vw_communications

Name	Datatype	Description
id	text	Id of the resource.
name	text	Name of the resource.
body	text	field from the properties object
communicationName	text	field from the properties object
communication_direction	text	field from the properties object
communication_type	text	field from the properties object
created_date	text	field from the properties object
sender	text	field from the properties object
subject	text	field from the properties object
subscriptionId	text	field from the properties object
supportTicketName	text	field from the properties object
type	text	Type of the resource 'Microsoft.Support/communications'.

communications

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

Methods

Name	Accessible by	Required Params	Description
get	SELECT	communicationName, subscriptionId, supportTicketName	Returns communication details for a support ticket.
list	SELECT	subscriptionId, supportTicketName	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	communicationName, subscriptionId, supportTicketName	Adds a new customer communication to an Azure support ticket.
check_name_availability	EXEC	subscriptionId, supportTicketName, data__name, data__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.

SELECT examples

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.

vw_communications

SELECT
id,
name,
body,
communicationName,
communication_direction,
communication_type,
created_date,
sender,
subject,
subscriptionId,
supportTicketName,
type
FROM azure.support.vw_communications
WHERE subscriptionId = '{{ subscriptionId }}'
AND supportTicketName = '{{ supportTicketName }}';

communications

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

INSERT example

Use the following StackQL query and manifest file to create a new communications resource.

All Properties

/*+ create */
INSERT INTO azure.support.communications (
communicationName,
subscriptionId,
supportTicketName,
properties
)
SELECT 
'{{ communicationName }}',
'{{ subscriptionId }}',
'{{ supportTicketName }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: id
      value: string
    - name: name
      value: string
    - name: type
      value: string
    - name: properties
      value:
        - name: communicationType
          value: string
        - name: communicationDirection
          value: string
        - name: sender
          value: string
        - name: subject
          value: string
        - name: body
          value: string
        - name: createdDate
          value: string