tickets

Creates, updates, deletes, gets or lists a tickets resource.

Overview

Name	tickets
Type	Resource
Id	azure.support.tickets

Fields

The following fields are returned by SELECT queries:

get

Successfully retrieved support ticket.

Name	Datatype	Description
id	string	Id of the resource.
name	string	Name of the resource.
properties	object	Properties of the resource.
type	string	Type of the resource 'Microsoft.Support/supportTickets'.

list

Successfully retrieved support tickets.

Name	Datatype	Description
id	string	Id of the resource.
name	string	Name of the resource.
properties	object	Properties of the resource.
type	string	Type of the resource 'Microsoft.Support/supportTickets'.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	supportTicketName, subscriptionId		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	select	subscriptionId	$top, $filter	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.
create	insert	supportTicketName, subscriptionId		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.
update	update	supportTicketName, subscriptionId		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.
check_name_availability	exec	subscriptionId, name, type		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

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
subscriptionId	string	Azure subscription Id.
supportTicketName	string	Support ticket name.
$filter	string	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'.
$top	integer (int32)	The number of values to return in the collection. Default is 25 and max is 100.

SELECT examples

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.

SELECT
id,
name,
properties,
type
FROM azure.support.tickets
WHERE supportTicketName = '{{ supportTicketName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

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.

SELECT
id,
name,
properties,
type
FROM azure.support.tickets
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND $top = '{{ $top }}'
AND $filter = '{{ $filter }}'
;

INSERT examples

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.

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.

INSERT INTO azure.support.tickets (
data__properties,
supportTicketName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ supportTicketName }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: tickets
  props:
    - name: supportTicketName
      value: string
      description: Required parameter for the tickets resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the tickets resource.
    - name: properties
      value: object
      description: |
        Properties of the resource.

UPDATE examples

update

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.

UPDATE azure.support.tickets
SET 
data__severity = '{{ severity }}',
data__status = '{{ status }}',
data__contactDetails = '{{ contactDetails }}',
data__advancedDiagnosticConsent = '{{ advancedDiagnosticConsent }}',
data__secondaryConsent = '{{ secondaryConsent }}'
WHERE 
supportTicketName = '{{ supportTicketName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
RETURNING
id,
name,
properties,
type;

Lifecycle Methods

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.

EXEC azure.support.tickets.check_name_availability 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"name": "{{ name }}", 
"type": "{{ type }}"
}'
;