CommunicationsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

MicrosoftSupport's

<xref:communications> attribute.

Inheritance

builtins.object

CommunicationsOperations

Constructor

CommunicationsOperations(*args, **kwargs)

Methods

begin_create	Adds a new customer communication to an Azure support ticket.
check_name_availability	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	Returns communication details for a support ticket.
list	Lists all communications (attachments not included) for a support ticket. <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. :code:<br/>:code:>><<<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.

begin_create

Adds a new customer communication to an Azure support ticket.

async begin_create(support_ticket_name: str, communication_name: str, create_communication_parameters: _models.CommunicationDetails, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.CommunicationDetails]

Parameters

Name	Description
support_ticket_name Required	str Support ticket name. Required.
communication_name Required	str Communication name. Required.
create_communication_parameters Required	CommunicationDetails or IO[bytes] Communication object. Is either a CommunicationDetails type or a IO[bytes] type. Required.

Returns

Type	Description
AsyncLROPoller[CommunicationDetails]	An instance of AsyncLROPoller that returns either CommunicationDetails or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

check_name_availability

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.

async check_name_availability(support_ticket_name: str, check_name_availability_input: _models.CheckNameAvailabilityInput, *, content_type: str = 'application/json', **kwargs: Any) -> _models.CheckNameAvailabilityOutput

Parameters

Name	Description
support_ticket_name Required	str Support ticket name. Required.
check_name_availability_input Required	CheckNameAvailabilityInput or IO[bytes] Input to check. Is either a CheckNameAvailabilityInput type or a IO[bytes] type. Required.

Returns

Type	Description
CheckNameAvailabilityOutput	CheckNameAvailabilityOutput or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get

Returns communication details for a support ticket.

async get(support_ticket_name: str, communication_name: str, **kwargs: Any) -> CommunicationDetails

Parameters

Name	Description
support_ticket_name Required	str Support ticket name. Required.
communication_name Required	str Communication name. Required.

Returns

Type	Description
CommunicationDetails	CommunicationDetails or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list

Lists all communications (attachments not included) for a support ticket. <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. :code:<br/>:code:>><<<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.

list(support_ticket_name: str, top: int | None = None, filter: str | None = None, **kwargs: Any) -> AsyncIterable[CommunicationDetails]

Parameters

Name	Description
support_ticket_name Required	str Support ticket name. Required.
top Required	int The number of values to return in the collection. Default is 10 and max is 10. Default value is None.
filter Required	str 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. Default value is None.

Returns

Type	Description
AsyncItemPaged[CommunicationDetails]	An iterator like instance of either CommunicationDetails or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

Attributes

models

models = <module 'azure.mgmt.support.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\support\\models\\__init__.py'>