SupportTicketsOperations Class

SupportTicketsOperations async 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

SupportTicketsOperations

Constructor

SupportTicketsOperations(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	Creates a new support ticket for Subscription and Service limits (Quota), Technical, Billing, and Subscription Management issues for the specified subscription. Learn the prerequisites required to create a support ticket.:code: <br/>Always call the Services and ProblemClassifications API to get the most recent set of services and problem categories required for support ticket creation.:code:<br/>>>:code:<br/>Adding attachments is not currently supported via the API. To add a file to an existing support ticket, visit the Manage support ticket <https://portal.azure.com/#blade/Microsoft_Azure_Support/HelpAndSupportBlade/managesupportrequest>_<< page in the Azure portal, select the support ticket, and use the file upload control to add a new file.:code: <br/>Providing consent to share diagnostic information with Azure support is currently not supported via the API. The Azure support engineer working on your ticket will reach out to you for consent if your issue requires gathering diagnostic information from your Azure resources.:code:<br/>``<br/>Creating a support ticket for on-behalf-of: Include x-ms-authorization-auxiliary header to provide an auxiliary token as per documentation. The primary token will be from the tenant for whom a support ticket is being raised against the subscription, i.e. Cloud solution provider (CSP) customer tenant. The auxiliary token will be from the Cloud solution provider (CSP) partner tenant.
check_name_availability	Check the availability of a resource name. This API should be used to check the uniqueness of the name for support ticket creation for the selected subscription.
get	Get ticket details for an Azure subscription. 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	Lists all the support tickets for an Azure subscription. You can also filter the support tickets by Status or CreatedDate using the $filter parameter. Output will be a paged result with nextLink, using which you can retrieve the next set of support tickets. <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.
update	This API allows you to update the severity level, ticket status, and your contact information in the support ticket.:code: <br/>Note: The severity levels cannot be changed if a support ticket is actively being worked upon by an Azure support engineer. In such a case, contact your support engineer to request severity update by adding a new communication using the Communications API.:code:<br/>:code:>><<<br/>Changing the ticket status to closed is allowed only on an unassigned case. When an engineer is actively working on the ticket, send your ticket closure request by sending a note to your engineer.

begin_create

Creates a new support ticket for Subscription and Service limits (Quota), Technical, Billing, and Subscription Management issues for the specified subscription. Learn the prerequisites required to create a support ticket.:code:
<br/>Always call the Services and ProblemClassifications API to get the most recent set of services and problem categories required for support ticket creation.:code:<br/>>>:code:<br/>Adding attachments is not currently supported via the API. To add a file to an existing support ticket, visit the Manage support ticket <https://portal.azure.com/#blade/Microsoft_Azure_Support/HelpAndSupportBlade/managesupportrequest>_<< page in the Azure portal, select the support ticket, and use the file upload control to add a new file.:code:
<br/>Providing consent to share diagnostic information with Azure support is currently not supported via the API. The Azure support engineer working on your ticket will reach out to you for consent if your issue requires gathering diagnostic information from your Azure resources.:code:<br/>``<br/>Creating a support ticket for on-behalf-of: Include x-ms-authorization-auxiliary header to provide an auxiliary token as per documentation. The primary token will be from the tenant for whom a support ticket is being raised against the subscription, i.e. Cloud solution provider (CSP) customer tenant. The auxiliary token will be from the Cloud solution provider (CSP) partner tenant.

async begin_create(support_ticket_name: str, create_support_ticket_parameters: azure.mgmt.support.models._models_py3.SupportTicketDetails, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.support.models._models_py3.SupportTicketDetails]

Parameters

support_ticket_name

str

Required

Support ticket name.

create_support_ticket_parameters

SupportTicketDetails

Required

Support ticket request payload.

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 AsyncPollingMethod

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 AsyncLROPoller that returns either SupportTicketDetails or the result of cls(response)

Return type

AsyncLROPoller[SupportTicketDetails]

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 support ticket creation for the selected subscription.

async check_name_availability(check_name_availability_input: azure.mgmt.support.models._models_py3.CheckNameAvailabilityInput, **kwargs) -> azure.mgmt.support.models._models_py3.CheckNameAvailabilityOutput

Parameters

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

Get ticket details for an Azure subscription. 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.

async get(support_ticket_name: str, **kwargs) -> azure.mgmt.support.models._models_py3.SupportTicketDetails

Parameters

support_ticket_name

str

Required

Support ticket name.

cls

callable

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

Returns

SupportTicketDetails, or the result of cls(response)

Return type

SupportTicketDetails

Exceptions

HttpResponseError

list

Lists all the support tickets for an Azure subscription. You can also filter the support tickets by Status or CreatedDate using the $filter parameter. Output will be a paged result with nextLink, using which you can retrieve the next set of support tickets. <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(top: Optional[int] = None, filter: Optional[str] = None, **kwargs) -> AsyncIterable[azure.mgmt.support.models._models_py3.SupportTicketsListResult]

Parameters

top

int

default value: None

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

filter

str

default value: None

The filter to apply on the operation. We support 'odata v4.0' filter semantics. Learn more. Status filter can only be used with Equals ('eq') operator. For CreatedDate filter, the supported operators are Greater Than ('gt') and Greater Than or Equals ('ge'). When using both filters, combine them using the logical 'AND'.

cls

callable

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

Returns

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

Return type

AsyncItemPaged[SupportTicketsListResult]

Exceptions

HttpResponseError

update

This API allows you to update the severity level, ticket status, and your contact information in the support ticket.:code:
<br/>Note: The severity levels cannot be changed if a support ticket is actively being worked upon by an Azure support engineer. In such a case, contact your support engineer to request severity update by adding a new communication using the Communications API.:code:<br/>:code:>><<<br/>Changing the ticket status to closed is allowed only on an unassigned case. When an engineer is actively working on the ticket, send your ticket closure request by sending a note to your engineer.

async update(support_ticket_name: str, update_support_ticket: azure.mgmt.support.models._models_py3.UpdateSupportTicket, **kwargs) -> azure.mgmt.support.models._models_py3.SupportTicketDetails

Parameters

support_ticket_name

str

Required

Support ticket name.

update_support_ticket

UpdateSupportTicket

Required

UpdateSupportTicket object.

cls

callable

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

Returns

SupportTicketDetails, or the result of cls(response)

Return type

SupportTicketDetails

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'>