Communications - Get

Returns communication details for a support ticket.

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

URI Parameters

Name In Required Type Description
communicationName
path True
  • string

Communication name.

subscriptionId
path True
  • string

Azure subscription Id.

supportTicketName
path True
  • string

Support ticket name.

api-version
query True
  • string

API version.

Responses

Name Type Description
200 OK

Successfully retrieved communication details.

Other Status Codes

Error response describing why the operation failed.

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

Get communication details for a subscription support ticket

Sample Request

GET https://management.azure.com/subscriptions/subid/providers/Microsoft.Support/supportTickets/testticket/communications/testmessage?api-version=2020-04-01

Sample Response

{
  "id": "/subscriptions/subid/providers/Microsoft.Support/supportTickets/testticket/communications/testmessage",
  "name": "testmessage",
  "type": "Microsoft.Support/communications",
  "properties": {
    "subject": "this is a test message",
    "body": "this is a test message",
    "communicationType": "web",
    "communicationDirection": "outbound",
    "sender": "user@contoso.com",
    "createdDate": "2020-03-10T20:18:19Z"
  }
}

Definitions

CommunicationDetails

Object that represents a Communication resource.

CommunicationDirection

Direction of communication.

CommunicationType

Communication type.

ExceptionResponse

The API error.

ServiceError

The API error details.

ServiceErrorDetail

The error details.

CommunicationDetails

Object that represents a Communication resource.

Name Type Description
id
  • string

Id of the resource.

name
  • string

Name of the resource.

properties.body
  • string

Body of the communication.

properties.communicationDirection

Direction of communication.

properties.communicationType

Communication type.

properties.createdDate
  • string

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.

type
  • string

Type of the resource 'Microsoft.Support/communications'.

CommunicationDirection

Direction of communication.

Name Type Description
inbound
  • string
outbound
  • string

CommunicationType

Communication type.

Name Type Description
phone
  • string
web
  • string

ExceptionResponse

The API error.

Name Type Description
error

The API error details.

ServiceError

The API error details.

Name Type Description
code
  • string

The error code.

details

The list of error details.

message
  • string

The error message.

target
  • string

The target of the error.

ServiceErrorDetail

The error details.

Name Type Description
code
  • string

The error code.

message
  • string

The error message.

target
  • string

The target of the error.