Package com.azure.resourcemanager.support.models

Interface Communications

public interface Communications
Resource collection API of Communications.

  • Method Details

    • checkNameAvailabilityWithResponse

      com.azure.core.http.rest.Response<CheckNameAvailabilityOutput> checkNameAvailabilityWithResponse(String supportTicketName, CheckNameAvailabilityInput checkNameAvailabilityInput, com.azure.core.util.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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • checkNameAvailability

      CheckNameAvailabilityOutput 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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • list

      com.azure.core.http.rest.PagedIterable<CommunicationDetails> list(String supportTicketName)
      Lists all communications (attachments not included) for a support ticket. <br/></br> 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. <br/><br/>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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • list

      com.azure.core.http.rest.PagedIterable<CommunicationDetails> list(String supportTicketName, Integer top, String filter, com.azure.core.util.Context context)
      Lists all communications (attachments not included) for a support ticket. <br/></br> 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. <br/><br/>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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getWithResponse

      com.azure.core.http.rest.Response<CommunicationDetails> getWithResponse(String supportTicketName, String communicationName, com.azure.core.util.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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • get

      CommunicationDetails 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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getById

      CommunicationDetails getById(String id)
      Returns communication details for a support ticket.
      Parameters:
      id - the resource ID.
      Returns:
      object that represents a Communication resource along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getByIdWithResponse

      com.azure.core.http.rest.Response<CommunicationDetails> getByIdWithResponse(String id, com.azure.core.util.Context context)
      Returns communication details for a support ticket.
      Parameters:
      id - the resource ID.
      context - The context to associate with this operation.
      Returns:
      object that represents a Communication resource along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • define

      CommunicationDetails.DefinitionStages.Blank define(String name)
      Begins definition for a new CommunicationDetails resource.
      Parameters:
      name - resource name.
      Returns:
      the first stage of the new CommunicationDetails definition.