Communications - List

Service:

Support

API Version:

2024-04-01

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.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Support/supportTickets/{supportTicketName}/communications?api-version=2024-04-01

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Support/supportTickets/{supportTicketName}/communications?api-version=2024-04-01&$top={$top}&$filter={$filter}

URI Parameters

Name	In	Required	Type	Description
subscriptionId	path	True	string (uuid)	The ID of the target subscription. The value must be an UUID.
supportTicketName	path	True	string	The name of the SupportTicketDetails
api-version	query	True	string minLength: 1	The API version to use for this operation.
$filter	query		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	query		integer (int32)	The number of values to return in the collection. Default is 10 and max is 10.

Responses

Name	Type	Description
200 OK	CommunicationsListResult	The request has succeeded.
Other Status Codes	ErrorResponse	An unexpected error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

List communications for a subscription support ticket

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

List web communications for a subscription support ticket

List communications for a subscription support ticket

Sample request

HTTP

GET https://management.azure.com/subscriptions/132d901f-189d-4381-9214-fe68e27e05a1/providers/Microsoft.Support/supportTickets/testticket/communications?api-version=2024-04-01

Go

package armsupport_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/support/armsupport/v2"
)

// Generated from example definition: 2024-04-01/ListCommunicationsForSubscriptionSupportTicket.json
func ExampleCommunicationsClient_NewListPager_listCommunicationsForASubscriptionSupportTicket() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsupport.NewClientFactory("132d901f-189d-4381-9214-fe68e27e05a1", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewCommunicationsClient().NewListPager("testticket", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page = armsupport.CommunicationsClientListResponse{
		// 	CommunicationsListResult: armsupport.CommunicationsListResult{
		// 		Value: []*armsupport.CommunicationDetails{
		// 			{
		// 				Name: to.Ptr("testmessage1"),
		// 				Type: to.Ptr("Microsoft.Support/communications"),
		// 				ID: to.Ptr("/subscriptions/132d901f-189d-4381-9214-fe68e27e05a1/providers/Microsoft.Support/supportTickets/testticket/communications/testmessage1"),
		// 				Properties: &armsupport.CommunicationDetailsProperties{
		// 					Body: to.Ptr("this is a test message"),
		// 					CommunicationDirection: to.Ptr(armsupport.CommunicationDirectionOutbound),
		// 					CommunicationType: to.Ptr(armsupport.CommunicationTypeWeb),
		// 					CreatedDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-03-24T20:18:19Z"); return t}()),
		// 					Sender: to.Ptr("user@contoso.com"),
		// 					Subject: to.Ptr("this is a test message"),
		// 				},
		// 			},
		// 			{
		// 				Name: to.Ptr("testmessage2"),
		// 				Type: to.Ptr("Microsoft.Support/communications"),
		// 				ID: to.Ptr("/subscriptions/132d901f-189d-4381-9214-fe68e27e05a1/providers/Microsoft.Support/supportTickets/testticket/communications/testmessage2"),
		// 				Properties: &armsupport.CommunicationDetailsProperties{
		// 					Body: to.Ptr("test"),
		// 					CommunicationDirection: to.Ptr(armsupport.CommunicationDirectionOutbound),
		// 					CommunicationType: to.Ptr(armsupport.CommunicationTypeWeb),
		// 					CreatedDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-03-29T10:53:19Z"); return t}()),
		// 					Sender: to.Ptr("user@contoso.com"),
		// 					Subject: to.Ptr("test"),
		// 				},
		// 			},
		// 		},
		// 	},
		// }
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:

200

{
  "value": [
    {
      "name": "testmessage1",
      "type": "Microsoft.Support/communications",
      "id": "/subscriptions/132d901f-189d-4381-9214-fe68e27e05a1/providers/Microsoft.Support/supportTickets/testticket/communications/testmessage1",
      "properties": {
        "body": "this is a test message",
        "communicationDirection": "outbound",
        "communicationType": "web",
        "createdDate": "2020-03-24T20:18:19Z",
        "sender": "user@contoso.com",
        "subject": "this is a test message"
      }
    },
    {
      "name": "testmessage2",
      "type": "Microsoft.Support/communications",
      "id": "/subscriptions/132d901f-189d-4381-9214-fe68e27e05a1/providers/Microsoft.Support/supportTickets/testticket/communications/testmessage2",
      "properties": {
        "body": "test",
        "communicationDirection": "outbound",
        "communicationType": "web",
        "createdDate": "2020-03-29T10:53:19Z",
        "sender": "user@contoso.com",
        "subject": "test"
      }
    }
  ]
}

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

Sample request

HTTP

GET https://management.azure.com/subscriptions/132d901f-189d-4381-9214-fe68e27e05a1/providers/Microsoft.Support/supportTickets/testticket/communications?api-version=2024-04-01&$filter=communicationType eq 'web' and createdDate ge 2020-03-10T22:08:51Z

Go

package armsupport_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/support/armsupport/v2"
)

// Generated from example definition: 2024-04-01/ListWebCommunicationsForSubscriptionSupportTicketCreatedOnOrAfter.json
func ExampleCommunicationsClient_NewListPager_listWebCommunicationCreatedOnOrAfterASpecificDateForASubscriptionSupportTicket() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsupport.NewClientFactory("132d901f-189d-4381-9214-fe68e27e05a1", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewCommunicationsClient().NewListPager("testticket", &armsupport.CommunicationsClientListOptions{
		Filter: to.Ptr("communicationType eq 'web' and createdDate ge 2020-03-10T22:08:51Z")})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page = armsupport.CommunicationsClientListResponse{
		// 	CommunicationsListResult: armsupport.CommunicationsListResult{
		// 		Value: []*armsupport.CommunicationDetails{
		// 			{
		// 				Name: to.Ptr("testmessage1"),
		// 				Type: to.Ptr("Microsoft.Support/communications"),
		// 				ID: to.Ptr("/subscriptions/132d901f-189d-4381-9214-fe68e27e05a1/providers/Microsoft.Support/supportTickets/testticket/communications/testmessage1"),
		// 				Properties: &armsupport.CommunicationDetailsProperties{
		// 					Body: to.Ptr("this is a test message"),
		// 					CommunicationDirection: to.Ptr(armsupport.CommunicationDirectionOutbound),
		// 					CommunicationType: to.Ptr(armsupport.CommunicationTypeWeb),
		// 					CreatedDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-03-11T20:18:19Z"); return t}()),
		// 					Sender: to.Ptr("user@contoso.com"),
		// 					Subject: to.Ptr("this is a test message"),
		// 				},
		// 			},
		// 			{
		// 				Name: to.Ptr("testmessage2"),
		// 				Type: to.Ptr("Microsoft.Support/communications"),
		// 				ID: to.Ptr("/subscriptions/132d901f-189d-4381-9214-fe68e27e05a1/providers/Microsoft.Support/supportTickets/testticket/communications/testmessage2"),
		// 				Properties: &armsupport.CommunicationDetailsProperties{
		// 					Body: to.Ptr("test"),
		// 					CommunicationDirection: to.Ptr(armsupport.CommunicationDirectionOutbound),
		// 					CommunicationType: to.Ptr(armsupport.CommunicationTypeWeb),
		// 					CreatedDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-03-12T10:53:19Z"); return t}()),
		// 					Sender: to.Ptr("user@contoso.com"),
		// 					Subject: to.Ptr("test"),
		// 				},
		// 			},
		// 		},
		// 	},
		// }
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:

200

{
  "value": [
    {
      "name": "testmessage1",
      "type": "Microsoft.Support/communications",
      "id": "/subscriptions/132d901f-189d-4381-9214-fe68e27e05a1/providers/Microsoft.Support/supportTickets/testticket/communications/testmessage1",
      "properties": {
        "body": "this is a test message",
        "communicationDirection": "outbound",
        "communicationType": "web",
        "createdDate": "2020-03-11T20:18:19Z",
        "sender": "user@contoso.com",
        "subject": "this is a test message"
      }
    },
    {
      "name": "testmessage2",
      "type": "Microsoft.Support/communications",
      "id": "/subscriptions/132d901f-189d-4381-9214-fe68e27e05a1/providers/Microsoft.Support/supportTickets/testticket/communications/testmessage2",
      "properties": {
        "body": "test",
        "communicationDirection": "outbound",
        "communicationType": "web",
        "createdDate": "2020-03-12T10:53:19Z",
        "sender": "user@contoso.com",
        "subject": "test"
      }
    }
  ]
}

List web communications for a subscription support ticket

Sample request

HTTP

GET https://management.azure.com/subscriptions/132d901f-189d-4381-9214-fe68e27e05a1/providers/Microsoft.Support/supportTickets/testticket/communications?api-version=2024-04-01&$filter=communicationType eq 'web'

Go

package armsupport_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/support/armsupport/v2"
)

// Generated from example definition: 2024-04-01/ListWebCommunicationsForSubscriptionSupportTicket.json
func ExampleCommunicationsClient_NewListPager_listWebCommunicationsForASubscriptionSupportTicket() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsupport.NewClientFactory("132d901f-189d-4381-9214-fe68e27e05a1", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewCommunicationsClient().NewListPager("testticket", &armsupport.CommunicationsClientListOptions{
		Filter: to.Ptr("communicationType eq 'web'")})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page = armsupport.CommunicationsClientListResponse{
		// 	CommunicationsListResult: armsupport.CommunicationsListResult{
		// 		Value: []*armsupport.CommunicationDetails{
		// 			{
		// 				Name: to.Ptr("testmessage1"),
		// 				Type: to.Ptr("Microsoft.Support/communications"),
		// 				ID: to.Ptr("/subscriptions/132d901f-189d-4381-9214-fe68e27e05a1/providers/Microsoft.Support/supportTickets/testticket/communications/testmessage1"),
		// 				Properties: &armsupport.CommunicationDetailsProperties{
		// 					Body: to.Ptr("this is a test message"),
		// 					CommunicationDirection: to.Ptr(armsupport.CommunicationDirectionOutbound),
		// 					CommunicationType: to.Ptr(armsupport.CommunicationTypeWeb),
		// 					CreatedDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-03-10T20:18:19Z"); return t}()),
		// 					Sender: to.Ptr("user@contoso.com"),
		// 					Subject: to.Ptr("this is a test message"),
		// 				},
		// 			},
		// 			{
		// 				Name: to.Ptr("testmessage2"),
		// 				Type: to.Ptr("Microsoft.Support/communications"),
		// 				ID: to.Ptr("/subscriptions/132d901f-189d-4381-9214-fe68e27e05a1/providers/Microsoft.Support/supportTickets/testticket/communications/testmessage2"),
		// 				Properties: &armsupport.CommunicationDetailsProperties{
		// 					Body: to.Ptr("test"),
		// 					CommunicationDirection: to.Ptr(armsupport.CommunicationDirectionOutbound),
		// 					CommunicationType: to.Ptr(armsupport.CommunicationTypeWeb),
		// 					CreatedDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-03-11T10:53:19Z"); return t}()),
		// 					Sender: to.Ptr("user@contoso.com"),
		// 					Subject: to.Ptr("test"),
		// 				},
		// 			},
		// 		},
		// 	},
		// }
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:

200

{
  "value": [
    {
      "name": "testmessage1",
      "type": "Microsoft.Support/communications",
      "id": "/subscriptions/132d901f-189d-4381-9214-fe68e27e05a1/providers/Microsoft.Support/supportTickets/testticket/communications/testmessage1",
      "properties": {
        "body": "this is a test message",
        "communicationDirection": "outbound",
        "communicationType": "web",
        "createdDate": "2020-03-10T20:18:19Z",
        "sender": "user@contoso.com",
        "subject": "this is a test message"
      }
    },
    {
      "name": "testmessage2",
      "type": "Microsoft.Support/communications",
      "id": "/subscriptions/132d901f-189d-4381-9214-fe68e27e05a1/providers/Microsoft.Support/supportTickets/testticket/communications/testmessage2",
      "properties": {
        "body": "test",
        "communicationDirection": "outbound",
        "communicationType": "web",
        "createdDate": "2020-03-11T10:53:19Z",
        "sender": "user@contoso.com",
        "subject": "test"
      }
    }
  ]
}

Definitions

Name	Description
CommunicationDetails	Object that represents a Communication resource.
CommunicationDirection	Direction of communication.
CommunicationsListResult	[Placeholder] Description for page model
CommunicationType	Communication type.
createdByType	The type of identity that created the resource.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
systemData	Metadata pertaining to creation and last modification of the resource.

CommunicationDetails

Object

Object that represents a Communication resource.

Name	Type	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties.body	string	Body of the communication.
properties.communicationDirection	CommunicationDirection	Direction of communication.
properties.communicationType	CommunicationType	Communication type.
properties.createdDate	string (date-time)	Time in UTC (ISO 8601 format) when the communication was created.
properties.sender	string	Email address of the sender. This property is required if called by a service principal.
properties.subject	string	Subject of the communication.
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

CommunicationDirection

Enumeration

Direction of communication.

Value	Description
inbound
outbound

CommunicationsListResult

Object

[Placeholder] Description for page model

Name	Type	Description
nextLink	string	[Placeholder] Description for nextLink property
value	CommunicationDetails[]	[Placeholder] Description for value property

CommunicationType

Enumeration

Communication type.

Value	Description
web
phone

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string (date-time)	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.