CommunicationsOperations Class

CommunicationsOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Inheritance

builtins.object

CommunicationsOperations

Constructor

CommunicationsOperations(client, config, serializer, deserializer)

Parameters

client

Required

Client for service requests.

config

Required

Configuration of service client.

serializer

Required

An object model serializer.

deserializer

Required

An object model deserializer.

Variables

models

Alias to model classes used in this operation group.

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.

begin_create(support_ticket_name: str, communication_name: str, create_communication_parameters: _models.CommunicationDetails, **kwargs: Any) -> LROPoller[_models.CommunicationDetails]

Parameters

support_ticket_name

str

Required

Support ticket name.

communication_name

str

Required

Communication name.

create_communication_parameters

CommunicationDetails

Required

Communication object.

cls

callable

A custom type or function that will be passed the direct response

continuation_token

str

A continuation token to restart a poller from a saved state.

polling

bool or PollingMethod

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

polling_interval

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either CommunicationDetails or the result of cls(response)

Return type

LROPoller[CommunicationDetails]

Exceptions

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.

check_name_availability(support_ticket_name: str, check_name_availability_input: _models.CheckNameAvailabilityInput, **kwargs: Any) -> _models.CheckNameAvailabilityOutput

Parameters

support_ticket_name

str

Required

Support ticket name.

check_name_availability_input

CheckNameAvailabilityInput

Required

Input to check.

cls

callable

A custom type or function that will be passed the direct response

Returns

CheckNameAvailabilityOutput, or the result of cls(response)

Return type

CheckNameAvailabilityOutput

Exceptions

HttpResponseError

get

Returns communication details for a support ticket.

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

Parameters

support_ticket_name

str

Required

Support ticket name.

communication_name

str

Required

Communication name.

cls

callable

A custom type or function that will be passed the direct response

Returns

CommunicationDetails, or the result of cls(response)

Return type

CommunicationDetails

Exceptions

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: Optional[int] = None, filter: Optional[str] = None, **kwargs: Any) -> Iterable[_models.CommunicationsListResult]

Parameters

support_ticket_name

str

Required

Support ticket name.

top

int

default value: None

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

filter

str

default value: None

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.

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either CommunicationsListResult or the result of cls(response)

Return type

ItemPaged[CommunicationsListResult]

Exceptions

HttpResponseError

Attributes

models

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