Communications - Create

Service:

Support

API Version:

2020-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=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

HTTP

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"
  }
}

Java

/** Samples for Communications Create. */
public final class Main {
    /*
     * x-ms-original-file: specification/support/resource-manager/Microsoft.Support/stable/2020-04-01/examples/CreateSupportTicketCommunication.json
     */
    /**
     * Sample code: AddCommunicationToSubscriptionTicket.
     *
     * @param manager Entry point to SupportManager.
     */
    public static void addCommunicationToSubscriptionTicket(com.azure.resourcemanager.support.SupportManager manager) {
        manager
            .communications()
            .define("testcommunication")
            .withExistingSupportTicket("testticket")
            .withSender("user@contoso.com")
            .withSubject("This is a test message from a customer!")
            .withBody("This is a test message from a customer!")
            .create();
    }
}

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

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.support import MicrosoftSupport

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-support
# USAGE
    python add_communication_to_subscription_ticket.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = MicrosoftSupport(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.communications.begin_create(
        support_ticket_name="testticket",
        communication_name="testcommunication",
        create_communication_parameters={
            "properties": {
                "body": "This is a test message from a customer!",
                "sender": "user@contoso.com",
                "subject": "This is a test message from a customer!",
            }
        },
    ).result()
    print(response)


# x-ms-original-file: specification/support/resource-manager/Microsoft.Support/stable/2020-04-01/examples/CreateSupportTicketCommunication.json
if __name__ == "__main__":
    main()

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

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"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/support/resource-manager/Microsoft.Support/stable/2020-04-01/examples/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("<subscription-id>", 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 pull 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.CommunicationDetails = armsupport.CommunicationDetails{
	// 	Name: to.Ptr("testcommunication"),
	// 	Type: to.Ptr("Microsoft.Support/communications"),
	// 	ID: to.Ptr("/subscriptions/subid/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:19.000Z"); 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

JavaScript

const { MicrosoftSupport } = require("@azure/arm-support");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Adds a new customer communication to an Azure support ticket.
 *
 * @summary Adds a new customer communication to an Azure support ticket.
 * x-ms-original-file: specification/support/resource-manager/Microsoft.Support/stable/2020-04-01/examples/CreateSupportTicketCommunication.json
 */
async function addCommunicationToSubscriptionTicket() {
  const subscriptionId = process.env["SUPPORT_SUBSCRIPTION_ID"] || "subid";
  const supportTicketName = "testticket";
  const communicationName = "testcommunication";
  const createCommunicationParameters = {
    body: "This is a test message from a customer!",
    sender: "user@contoso.com",
    subject: "This is a test message from a customer!",
  };
  const credential = new DefaultAzureCredential();
  const client = new MicrosoftSupport(credential, subscriptionId);
  const result = await client.communications.beginCreateAndWait(
    supportTicketName,
    communicationName,
    createCommunicationParameters
  );
  console.log(result);
}

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

dotnet

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Support;

// Generated from example definition: specification/support/resource-manager/Microsoft.Support/stable/2020-04-01/examples/CreateSupportTicketCommunication.json
// this example is just showing the usage of "Communications_Create" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SupportTicketResource created on azure
// for more information of creating SupportTicketResource, please refer to the document of SupportTicketResource
string subscriptionId = "subid";
string supportTicketName = "testticket";
ResourceIdentifier supportTicketResourceId = SupportTicketResource.CreateResourceIdentifier(subscriptionId, supportTicketName);
SupportTicketResource supportTicket = client.GetSupportTicketResource(supportTicketResourceId);

// get the collection of this SupportTicketCommunicationResource
SupportTicketCommunicationCollection collection = supportTicket.GetSupportTicketCommunications();

// invoke the operation
string communicationName = "testcommunication";
SupportTicketCommunicationData data = new SupportTicketCommunicationData()
{
    Sender = "user@contoso.com",
    Subject = "This is a test message from a customer!",
    Body = "This is a test message from a customer!",
};
ArmOperation<SupportTicketCommunicationResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, communicationName, data);
SupportTicketCommunicationResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
SupportTicketCommunicationData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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:

202

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

Status code:

200

{
  "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.