support_tickets

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

Overview

Name	support_tickets
Type	Resource
Id	azure.support.support_tickets

Fields

The following fields are returned by SELECT queries:

check_name_availability

Name	Datatype	Description
message	string	The detailed error message describing why the name is not available.
nameAvailable	boolean	Indicates whether the name is available.
reason	string	The reason why the name is not available.

get

Name	Datatype	Description
id	string	Id of the resource.
name	string	Name of the resource.
advancedDiagnosticConsent	string	Advanced diagnostic consent to be updated on the support ticket. Required. Known values are: "Yes" and "No".
contactDetails	object	Contact information of the user requesting to create a support ticket. Required.
createdDate	string (date-time)	Time in UTC (ISO 8601 format) when the support ticket was created.
description	string	Detailed description of the question or issue. Required.
enrollmentId	string	Enrollment Id associated with the support ticket.
fileWorkspaceName	string	File workspace name.
isTemporaryTicket	string	This property indicates if support ticket is a temporary ticket. Known values are: "Yes" and "No".
modifiedDate	string (date-time)	Time in UTC (ISO 8601 format) when the support ticket was last modified.
problemClassificationDisplayName	string	Localized name of problem classification.
problemClassificationId	string	Each Azure service has its own set of issue categories, also known as problem classification. This parameter is the unique Id for the type of problem you are experiencing. Required.
problemScopingQuestions	string	Problem scoping questions associated with the support ticket.
problemStartTime	string (date-time)	Time in UTC (ISO 8601 format) when the problem started.
quotaTicketDetails	object	Additional ticket details associated with a quota support ticket request.
require24X7Response	boolean	Indicates if this requires a 24x7 response from Azure.
secondaryConsent	array	This property indicates secondary consents for the support ticket.
serviceDisplayName	string	Localized name of the Azure service.
serviceId	string	This is the resource Id of the Azure service resource associated with the support ticket. Required.
serviceLevelAgreement	object	Service Level Agreement information for this support ticket.
severity	string	A value that indicates the urgency of the case, which in turn determines the response time according to the service level agreement of the technical support plan you have with Azure. Note: 'Highest critical impact', also known as the 'Emergency - Severe impact' level in the Azure portal is reserved only for our Premium customers. Required. Known values are: "minimal", "moderate", "critical", and "highestcriticalimpact".
status	string	Status of the support ticket.
supportEngineer	object	Information about the support engineer working on this support ticket.
supportPlanDisplayName	string	Support plan type associated with the support ticket.
supportPlanId	string	Support plan id associated with the support ticket.
supportPlanType	string	Support plan type associated with the support ticket.
supportTicketId	string	System generated support ticket Id that is unique.
technicalTicketDetails	object	Additional ticket details associated with a technical support ticket request.
title	string	Title of the support ticket. Required.
type	string	Type of the resource 'Microsoft.Support/supportTickets'.

list

Name	Datatype	Description
id	string	Id of the resource.
name	string	Name of the resource.
advancedDiagnosticConsent	string	Advanced diagnostic consent to be updated on the support ticket. Required. Known values are: "Yes" and "No".
contactDetails	object	Contact information of the user requesting to create a support ticket. Required.
createdDate	string (date-time)	Time in UTC (ISO 8601 format) when the support ticket was created.
description	string	Detailed description of the question or issue. Required.
enrollmentId	string	Enrollment Id associated with the support ticket.
fileWorkspaceName	string	File workspace name.
isTemporaryTicket	string	This property indicates if support ticket is a temporary ticket. Known values are: "Yes" and "No".
modifiedDate	string (date-time)	Time in UTC (ISO 8601 format) when the support ticket was last modified.
problemClassificationDisplayName	string	Localized name of problem classification.
problemClassificationId	string	Each Azure service has its own set of issue categories, also known as problem classification. This parameter is the unique Id for the type of problem you are experiencing. Required.
problemScopingQuestions	string	Problem scoping questions associated with the support ticket.
problemStartTime	string (date-time)	Time in UTC (ISO 8601 format) when the problem started.
quotaTicketDetails	object	Additional ticket details associated with a quota support ticket request.
require24X7Response	boolean	Indicates if this requires a 24x7 response from Azure.
secondaryConsent	array	This property indicates secondary consents for the support ticket.
serviceDisplayName	string	Localized name of the Azure service.
serviceId	string	This is the resource Id of the Azure service resource associated with the support ticket. Required.
serviceLevelAgreement	object	Service Level Agreement information for this support ticket.
severity	string	A value that indicates the urgency of the case, which in turn determines the response time according to the service level agreement of the technical support plan you have with Azure. Note: 'Highest critical impact', also known as the 'Emergency - Severe impact' level in the Azure portal is reserved only for our Premium customers. Required. Known values are: "minimal", "moderate", "critical", and "highestcriticalimpact".
status	string	Status of the support ticket.
supportEngineer	object	Information about the support engineer working on this support ticket.
supportPlanDisplayName	string	Support plan type associated with the support ticket.
supportPlanId	string	Support plan id associated with the support ticket.
supportPlanType	string	Support plan type associated with the support ticket.
supportTicketId	string	System generated support ticket Id that is unique.
technicalTicketDetails	object	Additional ticket details associated with a technical support ticket request.
title	string	Title of the support ticket. Required.
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
check_name_availability	select	subscription_id		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	select	support_ticket_name, subscription_id		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	subscription_id	$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	support_ticket_name, subscription_id, properties		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	support_ticket_name, subscription_id		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

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
subscription_id	string
support_ticket_name	string	Support ticket name. Required.
$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'. Default value is None.
$top	integer	The number of values to return in the collection. Default is 25 and max is 100. Default value is None.

SELECT examples

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.

SELECT
message,
nameAvailable,
reason
FROM azure.support.support_tickets
WHERE subscription_id = '{{ subscription_id }}' -- required
;

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,
advancedDiagnosticConsent,
contactDetails,
createdDate,
description,
enrollmentId,
fileWorkspaceName,
isTemporaryTicket,
modifiedDate,
problemClassificationDisplayName,
problemClassificationId,
problemScopingQuestions,
problemStartTime,
quotaTicketDetails,
require24X7Response,
secondaryConsent,
serviceDisplayName,
serviceId,
serviceLevelAgreement,
severity,
status,
supportEngineer,
supportPlanDisplayName,
supportPlanId,
supportPlanType,
supportTicketId,
technicalTicketDetails,
title,
type
FROM azure.support.support_tickets
WHERE support_ticket_name = '{{ support_ticket_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- 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,
advancedDiagnosticConsent,
contactDetails,
createdDate,
description,
enrollmentId,
fileWorkspaceName,
isTemporaryTicket,
modifiedDate,
problemClassificationDisplayName,
problemClassificationId,
problemScopingQuestions,
problemStartTime,
quotaTicketDetails,
require24X7Response,
secondaryConsent,
serviceDisplayName,
serviceId,
serviceLevelAgreement,
severity,
status,
supportEngineer,
supportPlanDisplayName,
supportPlanId,
supportPlanType,
supportTicketId,
technicalTicketDetails,
title,
type
FROM azure.support.support_tickets
WHERE subscription_id = '{{ subscription_id }}' -- 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.support_tickets (
properties,
support_ticket_name,
subscription_id
)
SELECT 
'{{ properties }}' /* required */,
'{{ support_ticket_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: support_tickets
props:
  - name: support_ticket_name
    value: "{{ support_ticket_name }}"
    description: Required parameter for the support_tickets resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the support_tickets resource.
  - name: properties
    value:
      supportTicketId: "{{ supportTicketId }}"
      description: "{{ description }}"
      problemClassificationId: "{{ problemClassificationId }}"
      severity: "{{ severity }}"
      enrollmentId: "{{ enrollmentId }}"
      require24X7Response: {{ require24X7Response }}
      advancedDiagnosticConsent: "{{ advancedDiagnosticConsent }}"
      problemScopingQuestions: "{{ problemScopingQuestions }}"
      supportPlanId: "{{ supportPlanId }}"
      contactDetails:
        firstName: "{{ firstName }}"
        lastName: "{{ lastName }}"
        preferredContactMethod: "{{ preferredContactMethod }}"
        primaryEmailAddress: "{{ primaryEmailAddress }}"
        additionalEmailAddresses:
          - "{{ additionalEmailAddresses }}"
        phoneNumber: "{{ phoneNumber }}"
        preferredTimeZone: "{{ preferredTimeZone }}"
        country: "{{ country }}"
        preferredSupportLanguage: "{{ preferredSupportLanguage }}"
      serviceLevelAgreement:
        startTime: "{{ startTime }}"
        expirationTime: "{{ expirationTime }}"
        slaMinutes: {{ slaMinutes }}
      supportEngineer:
        emailAddress: "{{ emailAddress }}"
      title: "{{ title }}"
      problemStartTime: "{{ problemStartTime }}"
      serviceId: "{{ serviceId }}"
      fileWorkspaceName: "{{ fileWorkspaceName }}"
      technicalTicketDetails:
        resourceId: "{{ resourceId }}"
      quotaTicketDetails:
        quotaChangeRequestSubType: "{{ quotaChangeRequestSubType }}"
        quotaChangeRequestVersion: "{{ quotaChangeRequestVersion }}"
        quotaChangeRequests:
          - region: "{{ region }}"
            payload: "{{ payload }}"
      secondaryConsent:
        - userConsent: "{{ userConsent }}"
          type: "{{ type }}"

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.support_tickets
SET 
severity = '{{ severity }}',
status = '{{ status }}',
contactDetails = '{{ contactDetails }}',
advancedDiagnosticConsent = '{{ advancedDiagnosticConsent }}',
secondaryConsent = '{{ secondaryConsent }}'
WHERE 
support_ticket_name = '{{ support_ticket_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
type;