Communications - Create

Service:

Support

API Version:

2024-04-01

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=2024-04-01

URI Parameters

Name	In	Required	Type	Description
communicationName	path	True	string	The name of the CommunicationDetails
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.

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	Resource 'CommunicationDetails' update operation succeeded
202 Accepted		Resource operation accepted. Headers Location: string Retry-After: integer
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

AddCommunicationToSubscriptionTicket

Sample request

HTTP

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

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

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/CreateSupportTicketCommunication.json
func ExampleCommunicationsClient_BeginCreate() {
	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)
	}
	poller, err := clientFactory.NewCommunicationsClient().BeginCreate(ctx, "testticket", "testcommunication", armsupport.CommunicationDetails{
		Properties: &armsupport.CommunicationDetailsProperties{
			Body:    to.Ptr("This is a test message from a customer!"),
			Sender:  to.Ptr("user@contoso.com"),
			Subject: to.Ptr("This is a test message from a customer!"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to poll the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armsupport.CommunicationsClientCreateResponse{
	// 	CommunicationDetails: armsupport.CommunicationDetails{
	// 		Name: to.Ptr("testcommunication"),
	// 		Type: to.Ptr("Microsoft.Support/communications"),
	// 		ID: to.Ptr("/subscriptions/132d901f-189d-4381-9214-fe68e27e05a1/providers/Microsoft.Support/supportTickets/testticket/communications/testcommunication"),
	// 		Properties: &armsupport.CommunicationDetailsProperties{
	// 			Body: to.Ptr("This is a test message from a customer!"),
	// 			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 from a customer!"),
	// 		},
	// 	},
	// }
}

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

{
  "name": "testcommunication",
  "type": "Microsoft.Support/communications",
  "id": "/subscriptions/132d901f-189d-4381-9214-fe68e27e05a1/providers/Microsoft.Support/supportTickets/testticket/communications/testcommunication",
  "properties": {
    "body": "This is a test message from a customer!",
    "communicationDirection": "outbound",
    "communicationType": "web",
    "createdDate": "2020-03-10T20:18:19Z",
    "sender": "user@contoso.com",
    "subject": "This is a test message from a customer!"
  }
}

Status code:

202

azure-asyncoperation: https://management.azure.com/subscriptions/132d901f-189d-4381-9214-fe68e27e05a1/providers/Microsoft.Support/operationsStatus/operationid?api-version=2024-04-01
location: https://management.azure.com/subscriptions/132d901f-189d-4381-9214-fe68e27e05a1/providers/Microsoft.Support/operationResults/operationid?api-version=2024-04-01

Definitions

Name	Description
CommunicationDetails	Object that represents a Communication resource.
CommunicationDirection	Direction of communication.
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

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.