Communications interface
Interface representing a Communications.
Methods
| begin |
Adds a new customer communication to an Azure support ticket. |
| begin |
Adds a new customer communication to an Azure support ticket. |
| check |
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. |
| get(string, string, Communications |
Returns communication details for a support ticket. |
| list(string, Communications |
Lists all communications (attachments not included) for a support ticket. |
Method Details
beginCreate(string, string, CommunicationDetails, CommunicationsCreateOptionalParams)
Adds a new customer communication to an Azure support ticket.
function beginCreate(supportTicketName: string, communicationName: string, createCommunicationParameters: CommunicationDetails, options?: CommunicationsCreateOptionalParams): Promise<SimplePollerLike<OperationState<CommunicationDetails>, CommunicationDetails>>Parameters
- supportTicketName
-
string
Support ticket name.
- communicationName
-
string
Communication name.
- createCommunicationParameters
- CommunicationDetails
Communication object.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<CommunicationDetails>, CommunicationDetails>>
beginCreateAndWait(string, string, CommunicationDetails, CommunicationsCreateOptionalParams)
Adds a new customer communication to an Azure support ticket.
function beginCreateAndWait(supportTicketName: string, communicationName: string, createCommunicationParameters: CommunicationDetails, options?: CommunicationsCreateOptionalParams): Promise<CommunicationDetails>Parameters
- supportTicketName
-
string
Support ticket name.
- communicationName
-
string
Communication name.
- createCommunicationParameters
- CommunicationDetails
Communication object.
The options parameters.
Returns
Promise<CommunicationDetails>
checkNameAvailability(string, CheckNameAvailabilityInput, CommunicationsCheckNameAvailabilityOptionalParams)
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.
function checkNameAvailability(supportTicketName: string, checkNameAvailabilityInput: CheckNameAvailabilityInput, options?: CommunicationsCheckNameAvailabilityOptionalParams): Promise<CheckNameAvailabilityOutput>Parameters
- supportTicketName
-
string
Support ticket name.
- checkNameAvailabilityInput
- CheckNameAvailabilityInput
Input to check.
The options parameters.
Returns
Promise<CheckNameAvailabilityOutput>
get(string, string, CommunicationsGetOptionalParams)
Returns communication details for a support ticket.
function get(supportTicketName: string, communicationName: string, options?: CommunicationsGetOptionalParams): Promise<CommunicationDetails>Parameters
- supportTicketName
-
string
Support ticket name.
- communicationName
-
string
Communication name.
- options
- CommunicationsGetOptionalParams
The options parameters.
Returns
Promise<CommunicationDetails>
list(string, CommunicationsListOptionalParams)
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.
function list(supportTicketName: string, options?: CommunicationsListOptionalParams): PagedAsyncIterableIterator<CommunicationDetails, CommunicationDetails[], PageSettings>Parameters
- supportTicketName
-
string
Support ticket name.
- options
- CommunicationsListOptionalParams
The options parameters.