SupportTickets interface
Interface representing a SupportTickets.
Methods
| begin |
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. |
| begin |
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. |
| check |
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(string, Support |
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(Support |
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. |
| update(string, Update |
This API allows you to update the severity level, ticket status, and your contact information in the
support ticket. |
Method Details
beginCreate(string, SupportTicketDetails, SupportTicketsCreateOptionalParams)
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.
Always call
the Services and ProblemClassifications API to get the most recent set of services and problem
categories required for support ticket creation.
Adding attachments is not currently
supported via the API. To add a file to an existing support ticket, visit the Manage support
ticket
page in the Azure portal, select the support ticket, and use the file upload control to add a new
file.
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.
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.
function beginCreate(supportTicketName: string, createSupportTicketParameters: SupportTicketDetails, options?: SupportTicketsCreateOptionalParams): Promise<PollerLike<PollOperationState<SupportTicketDetails>, SupportTicketDetails>>Parameters
- supportTicketName
-
string
Support ticket name.
- createSupportTicketParameters
- SupportTicketDetails
Support ticket request payload.
The options parameters.
Returns
beginCreateAndWait(string, SupportTicketDetails, SupportTicketsCreateOptionalParams)
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.
Always call
the Services and ProblemClassifications API to get the most recent set of services and problem
categories required for support ticket creation.
Adding attachments is not currently
supported via the API. To add a file to an existing support ticket, visit the Manage support
ticket
page in the Azure portal, select the support ticket, and use the file upload control to add a new
file.
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.
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.
function beginCreateAndWait(supportTicketName: string, createSupportTicketParameters: SupportTicketDetails, options?: SupportTicketsCreateOptionalParams): Promise<SupportTicketDetails>Parameters
- supportTicketName
-
string
Support ticket name.
- createSupportTicketParameters
- SupportTicketDetails
Support ticket request payload.
The options parameters.
Returns
Promise<SupportTicketDetails>
checkNameAvailability(CheckNameAvailabilityInput, SupportTicketsCheckNameAvailabilityOptionalParams)
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.
function checkNameAvailability(checkNameAvailabilityInput: CheckNameAvailabilityInput, options?: SupportTicketsCheckNameAvailabilityOptionalParams): Promise<CheckNameAvailabilityOutput>Parameters
- checkNameAvailabilityInput
- CheckNameAvailabilityInput
Input to check.
The options parameters.
Returns
Promise<CheckNameAvailabilityOutput>
get(string, SupportTicketsGetOptionalParams)
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.
function get(supportTicketName: string, options?: SupportTicketsGetOptionalParams): Promise<SupportTicketDetails>Parameters
- supportTicketName
-
string
Support ticket name.
- options
- SupportTicketsGetOptionalParams
The options parameters.
Returns
Promise<SupportTicketDetails>
list(SupportTicketsListOptionalParams)
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.
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(options?: SupportTicketsListOptionalParams): PagedAsyncIterableIterator<SupportTicketDetails, SupportTicketDetails[], PageSettings>Parameters
- options
- SupportTicketsListOptionalParams
The options parameters.
Returns
update(string, UpdateSupportTicket, SupportTicketsUpdateOptionalParams)
This API allows you to update the severity level, ticket status, and your contact information in the
support ticket.
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.
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.
function update(supportTicketName: string, updateSupportTicket: UpdateSupportTicket, options?: SupportTicketsUpdateOptionalParams): Promise<SupportTicketDetails>Parameters
- supportTicketName
-
string
Support ticket name.
- updateSupportTicket
- UpdateSupportTicket
UpdateSupportTicket object.
The options parameters.
Returns
Promise<SupportTicketDetails>