SupportTicketsClient Interface

public interface SupportTicketsClient

An instance of this class provides access to all the operations defined in SupportTicketsClient.

Method Summary

Modifier and Type Method and Description
abstract SyncPoller<PollResult<SupportTicketDetailsInner>,SupportTicketDetailsInner> beginCreate(String supportTicketName, SupportTicketDetailsInner createSupportTicketParameters)

Creates a new support ticket for Subscription and Service limits (Quota), Technical, Billing, and Subscription Management issues for the specified subscription.

abstract SyncPoller<PollResult<SupportTicketDetailsInner>,SupportTicketDetailsInner> beginCreate(String supportTicketName, SupportTicketDetailsInner createSupportTicketParameters, Context context)

Creates a new support ticket for Subscription and Service limits (Quota), Technical, Billing, and Subscription Management issues for the specified subscription.

abstract CheckNameAvailabilityOutputInner checkNameAvailability(CheckNameAvailabilityInput checkNameAvailabilityInput)

Check the availability of a resource name.

abstract Response<CheckNameAvailabilityOutputInner> checkNameAvailabilityWithResponse(CheckNameAvailabilityInput checkNameAvailabilityInput, Context context)

Check the availability of a resource name.

abstract SupportTicketDetailsInner create(String supportTicketName, SupportTicketDetailsInner createSupportTicketParameters)

Creates a new support ticket for Subscription and Service limits (Quota), Technical, Billing, and Subscription Management issues for the specified subscription.

abstract SupportTicketDetailsInner create(String supportTicketName, SupportTicketDetailsInner createSupportTicketParameters, Context context)

Creates a new support ticket for Subscription and Service limits (Quota), Technical, Billing, and Subscription Management issues for the specified subscription.

abstract SupportTicketDetailsInner get(String supportTicketName)

Get ticket details for an Azure subscription.

abstract Response<SupportTicketDetailsInner> getWithResponse(String supportTicketName, Context context)

Get ticket details for an Azure subscription.

abstract PagedIterable<SupportTicketDetailsInner> list()

Lists all the support tickets for an Azure subscription.

abstract PagedIterable<SupportTicketDetailsInner> list(Integer top, String filter, Context context)

Lists all the support tickets for an Azure subscription.

abstract SupportTicketDetailsInner update(String supportTicketName, UpdateSupportTicket updateSupportTicket)

This API allows you to update the severity level, ticket status, advanced diagnostic consent 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.

abstract Response<SupportTicketDetailsInner> updateWithResponse(String supportTicketName, UpdateSupportTicket updateSupportTicket, Context context)

This API allows you to update the severity level, ticket status, advanced diagnostic consent 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.

Method Details

beginCreate

public abstract SyncPoller<>,SupportTicketDetailsInner> beginCreate(String supportTicketName, SupportTicketDetailsInner createSupportTicketParameters)

Creates a new support ticket for Subscription and Service limits (Quota), Technical, Billing, and Subscription Management issues for the specified subscription. Learn the [prerequisites](https://aka.ms/supportAPI) 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](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.

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](https://docs.microsoft.com/azure/azure-resource-manager/management/authenticate-multi-tenant). 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.

Parameters:

supportTicketName - Support ticket name.
createSupportTicketParameters - Support ticket request payload.

Returns:

the SyncPoller<T,U> for polling of object that represents SupportTicketDetails resource.

beginCreate

public abstract SyncPoller<>,SupportTicketDetailsInner> beginCreate(String supportTicketName, SupportTicketDetailsInner createSupportTicketParameters, Context context)

Creates a new support ticket for Subscription and Service limits (Quota), Technical, Billing, and Subscription Management issues for the specified subscription. Learn the [prerequisites](https://aka.ms/supportAPI) 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](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.

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](https://docs.microsoft.com/azure/azure-resource-manager/management/authenticate-multi-tenant). 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.

Parameters:

supportTicketName - Support ticket name.
createSupportTicketParameters - Support ticket request payload.
context - The context to associate with this operation.

Returns:

the SyncPoller<T,U> for polling of object that represents SupportTicketDetails resource.

checkNameAvailability

public abstract CheckNameAvailabilityOutputInner checkNameAvailability(CheckNameAvailabilityInput checkNameAvailabilityInput)

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.

Parameters:

checkNameAvailabilityInput - Input to check.

Returns:

output of check name availability API.

checkNameAvailabilityWithResponse

public abstract Response checkNameAvailabilityWithResponse(CheckNameAvailabilityInput checkNameAvailabilityInput, Context context)

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.

Parameters:

checkNameAvailabilityInput - Input to check.
context - The context to associate with this operation.

Returns:

output of check name availability API along with Response<T>.

create

public abstract SupportTicketDetailsInner create(String supportTicketName, SupportTicketDetailsInner createSupportTicketParameters)

Creates a new support ticket for Subscription and Service limits (Quota), Technical, Billing, and Subscription Management issues for the specified subscription. Learn the [prerequisites](https://aka.ms/supportAPI) 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](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.

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](https://docs.microsoft.com/azure/azure-resource-manager/management/authenticate-multi-tenant). 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.

Parameters:

supportTicketName - Support ticket name.
createSupportTicketParameters - Support ticket request payload.

Returns:

object that represents SupportTicketDetails resource.

create

public abstract SupportTicketDetailsInner create(String supportTicketName, SupportTicketDetailsInner createSupportTicketParameters, Context context)

Creates a new support ticket for Subscription and Service limits (Quota), Technical, Billing, and Subscription Management issues for the specified subscription. Learn the [prerequisites](https://aka.ms/supportAPI) 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](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.

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](https://docs.microsoft.com/azure/azure-resource-manager/management/authenticate-multi-tenant). 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.

Parameters:

supportTicketName - Support ticket name.
createSupportTicketParameters - Support ticket request payload.
context - The context to associate with this operation.

Returns:

object that represents SupportTicketDetails resource.

get

public abstract SupportTicketDetailsInner get(String supportTicketName)

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.

Parameters:

supportTicketName - Support ticket name.

Returns:

ticket details for an Azure subscription.

getWithResponse

public abstract Response getWithResponse(String supportTicketName, Context context)

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.

Parameters:

supportTicketName - Support ticket name.
context - The context to associate with this operation.

Returns:

ticket details for an Azure subscription along with Response<T>.

list

public abstract PagedIterable 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.

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.

Returns:

object that represents a collection of SupportTicket resources as paginated response with PagedIterable<T>.

list

public abstract PagedIterable list(Integer top, String filter, Context context)

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.

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.

Parameters:

top - The number of values to return in the collection. Default is 25 and max is 100.
filter - 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'.
context - The context to associate with this operation.

Returns:

object that represents a collection of SupportTicket resources as paginated response with PagedIterable<T>.

update

public abstract SupportTicketDetailsInner update(String supportTicketName, UpdateSupportTicket updateSupportTicket)

This API allows you to update the severity level, ticket status, advanced diagnostic consent 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.

Parameters:

supportTicketName - Support ticket name.
updateSupportTicket - UpdateSupportTicket object.

Returns:

object that represents SupportTicketDetails resource.

updateWithResponse

public abstract Response updateWithResponse(String supportTicketName, UpdateSupportTicket updateSupportTicket, Context context)

This API allows you to update the severity level, ticket status, advanced diagnostic consent 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.

Parameters:

supportTicketName - Support ticket name.
updateSupportTicket - UpdateSupportTicket object.
context - The context to associate with this operation.

Returns:

object that represents SupportTicketDetails resource along with Response<T>.

Applies to