Communications - Create

Adds a new customer communication to an Azure support ticket.

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

Request Body

Name Required Type Description
properties.body True

string

Body of the communication.

properties.subject True

string

Subject of the communication.

properties.sender

string

Email address of the sender. This property is required if called by a service principal.

Responses

Name Type Description
200 OK

CommunicationDetails

OK - Communication created successfully.

202 Accepted

Accepted - Communication will be created asynchronously.

Other Status Codes

ExceptionResponse

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

AddCommunicationToSubscriptionTicket

Sample Request

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

{
  "properties": {
    "subject": "This is a test message from a customer!",
    "body": "This is a test message from a customer!",
    "sender": "user@contoso.com"
  }
}

Sample Response

location: https://management.azure.com/subscriptions/subid/providers/Microsoft.Support/operationResults/operationid?api-version=2020-04-01
azure-asyncoperation: https://management.azure.com/subscriptions/subid/providers/Microsoft.Support/operationsStatus/operationid?api-version=2020-04-01
{
  "id": "/subscriptions/subid/providers/Microsoft.Support/supportTickets/testticket/communications/testcommunication",
  "name": "testcommunication",
  "type": "Microsoft.Support/communications",
  "properties": {
    "subject": "This is a test message from a customer!",
    "body": "This is a test message from a customer!",
    "communicationType": "web",
    "communicationDirection": "outbound",
    "createdDate": "2020-03-10T20:18:19Z",
    "sender": "user@contoso.com"
  }
}

Definitions

Name Description
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

CommunicationDirection

Direction of communication.

properties.communicationType

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

ServiceError

The API error details.

ServiceError

The API error details.

Name Type Description
code

string

The error code.

details

ServiceErrorDetail[]

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.