SupportTicketsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

MicrosoftSupport's

<xref:support_tickets> attribute.

Inheritance

builtins.object

SupportTicketsOperations

Constructor

SupportTicketsOperations(*args, **kwargs)

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, CreatedDate, ServiceId, and ProblemClassificationId 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, advanced diagnostic consent and your contact information in the support ticket.:code: :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.

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: _models.SupportTicketDetails, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.SupportTicketDetails]

Parameters

Name	Description
support_ticket_name Required	str Support ticket name. Required.
create_support_ticket_parameters Required	SupportTicketDetails or IO[bytes] Support ticket request payload. Is either a SupportTicketDetails type or a IO[bytes] type. Required.

Returns

Type	Description
AsyncLROPoller[SupportTicketDetails]	An instance of AsyncLROPoller that returns either SupportTicketDetails 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 support ticket creation for the selected subscription.

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

Parameters

Name	Description
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

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: Any) -> SupportTicketDetails

Parameters

Name	Description
support_ticket_name Required	str Support ticket name. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

list

Lists all the support tickets for an Azure subscription. You can also filter the support tickets by Status, CreatedDate, ServiceId, and ProblemClassificationId 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: int | None = None, filter: str | None = None, **kwargs: Any) -> AsyncIterable[SupportTicketDetails]

Parameters

Name	Description
top Required	int The number of values to return in the collection. Default is 25 and max is 100. Default value is None.
filter Required	str The filter to apply on the operation. We support 'odata v4.0' filter semantics. Learn more. Status, ServiceId, and ProblemClassificationId filters 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'. Default value is None.

Returns

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

Exceptions

Type	Description
HttpResponseError

update

This API allows you to update the severity level, ticket status, advanced diagnostic consent and your contact information in the support ticket.:code:
: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.

async update(support_ticket_name: str, update_support_ticket: _models.UpdateSupportTicket, *, content_type: str = 'application/json', **kwargs: Any) -> _models.SupportTicketDetails

Parameters

Name	Description
support_ticket_name Required	str Support ticket name. Required.
update_support_ticket Required	UpdateSupportTicket or IO[bytes] UpdateSupportTicket object. Is either a UpdateSupportTicket type or a IO[bytes] type. Required.

Returns

Type	Description
SupportTicketDetails	SupportTicketDetails 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'>