CommunicationsClient Interface

Package:

com.azure.resourcemanager.support.fluent

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-support:1.1.0

public interface CommunicationsClient

An instance of this class provides access to all the operations defined in CommunicationsClient.

Method Summary

Modifier and Type	Method and Description
abstract SyncPoller<PollResult<CommunicationDetailsInner>,CommunicationDetailsInner>	beginCreate(String supportTicketName, String communicationName, CommunicationDetailsInner createCommunicationParameters) Adds a new customer communication to an Azure support ticket.
abstract SyncPoller<PollResult<CommunicationDetailsInner>,CommunicationDetailsInner>	beginCreate(String supportTicketName, String communicationName, CommunicationDetailsInner createCommunicationParameters, Context context) Adds a new customer communication to an Azure support ticket.
abstract CheckNameAvailabilityOutputInner	checkNameAvailability(String supportTicketName, CheckNameAvailabilityInput checkNameAvailabilityInput) Check the availability of a resource name.
abstract Response<CheckNameAvailabilityOutputInner>	checkNameAvailabilityWithResponse(String supportTicketName, CheckNameAvailabilityInput checkNameAvailabilityInput, Context context) Check the availability of a resource name.
abstract CommunicationDetailsInner	create(String supportTicketName, String communicationName, CommunicationDetailsInner createCommunicationParameters) Adds a new customer communication to an Azure support ticket.
abstract CommunicationDetailsInner	create(String supportTicketName, String communicationName, CommunicationDetailsInner createCommunicationParameters, Context context) Adds a new customer communication to an Azure support ticket.
abstract CommunicationDetailsInner	get(String supportTicketName, String communicationName) Returns communication details for a support ticket.
abstract Response<CommunicationDetailsInner>	getWithResponse(String supportTicketName, String communicationName, Context context) Returns communication details for a support ticket.
abstract PagedIterable<CommunicationDetailsInner>	list(String supportTicketName) Lists all communications (attachments not included) for a support ticket.
abstract PagedIterable<CommunicationDetailsInner>	list(String supportTicketName, Integer top, String filter, Context context) Lists all communications (attachments not included) for a support ticket.

Method Details

beginCreate

public abstract SyncPoller<PollResult<CommunicationDetailsInner>,CommunicationDetailsInner> beginCreate(String supportTicketName, String communicationName, CommunicationDetailsInner createCommunicationParameters)

Adds a new customer communication to an Azure support ticket.

Parameters:

supportTicketName - Support ticket name.

communicationName - Communication name.

createCommunicationParameters - Communication object.

Returns:

the SyncPoller<T,U> for polling of object that represents a Communication resource.

beginCreate

public abstract SyncPoller<PollResult<CommunicationDetailsInner>,CommunicationDetailsInner> beginCreate(String supportTicketName, String communicationName, CommunicationDetailsInner createCommunicationParameters, Context context)

Adds a new customer communication to an Azure support ticket.

Parameters:

supportTicketName - Support ticket name.

communicationName - Communication name.

createCommunicationParameters - Communication object.

context - The context to associate with this operation.

Returns:

the SyncPoller<T,U> for polling of object that represents a Communication resource.

checkNameAvailability

public abstract CheckNameAvailabilityOutputInner checkNameAvailability(String supportTicketName, CheckNameAvailabilityInput checkNameAvailabilityInput)

Check the availability of a resource name. This API should be used to check the uniqueness of the name for adding a new communication to the support ticket.

Parameters:

supportTicketName - Support ticket name.

checkNameAvailabilityInput - Input to check.

Returns:

output of check name availability API.

checkNameAvailabilityWithResponse

public abstract Response<CheckNameAvailabilityOutputInner> checkNameAvailabilityWithResponse(String supportTicketName, CheckNameAvailabilityInput checkNameAvailabilityInput, Context context)

Check the availability of a resource name. This API should be used to check the uniqueness of the name for adding a new communication to the support ticket.

Parameters:

supportTicketName - Support ticket name.

checkNameAvailabilityInput - Input to check.

context - The context to associate with this operation.

Returns:

output of check name availability API along with Response<T>.

create

public abstract CommunicationDetailsInner create(String supportTicketName, String communicationName, CommunicationDetailsInner createCommunicationParameters)

Adds a new customer communication to an Azure support ticket.

Parameters:

supportTicketName - Support ticket name.

communicationName - Communication name.

createCommunicationParameters - Communication object.

Returns:

object that represents a Communication resource.

create

public abstract CommunicationDetailsInner create(String supportTicketName, String communicationName, CommunicationDetailsInner createCommunicationParameters, Context context)

Adds a new customer communication to an Azure support ticket.

Parameters:

supportTicketName - Support ticket name.

communicationName - Communication name.

createCommunicationParameters - Communication object.

context - The context to associate with this operation.

Returns:

object that represents a Communication resource.

get

public abstract CommunicationDetailsInner get(String supportTicketName, String communicationName)

Returns communication details for a support ticket.

Parameters:

supportTicketName - Support ticket name.

communicationName - Communication name.

Returns:

object that represents a Communication resource.

getWithResponse

public abstract Response<CommunicationDetailsInner> getWithResponse(String supportTicketName, String communicationName, Context context)

Returns communication details for a support ticket.

Parameters:

supportTicketName - Support ticket name.

communicationName - Communication name.

context - The context to associate with this operation.

Returns:

object that represents a Communication resource along with Response<T>.

list

public abstract PagedIterable<CommunicationDetailsInner> list(String supportTicketName)

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.

Parameters:

supportTicketName - Support ticket name.

Returns:

collection of Communication resources as paginated response with PagedIterable<T>.

list

public abstract PagedIterable<CommunicationDetailsInner> list(String supportTicketName, Integer top, String filter, Context context)

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.

Parameters:

supportTicketName - Support ticket name.

top - The number of values to return in the collection. Default is 10 and max is 10.

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

context - The context to associate with this operation.

Returns:

collection of Communication resources as paginated response with PagedIterable<T>.