Support Tickets - List

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.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Support/supportTickets?api-version=2020-04-01
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Support/supportTickets?$top={$top}&$filter={$filter}&api-version=2020-04-01

URI Parameters

Name In Required Type Description
subscriptionId
path True
  • string

Azure subscription Id.

api-version
query True
  • string

API version.

$filter
query
  • string

The filter to apply on the operation. We support 'odata v4.0' filter semantics. Learn more. Status filter 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
query
  • integer

The number of values to return in the collection. Default is 25 and max is 100.

Responses

Name Type Description
200 OK

Successfully retrieved support tickets.

Other Status Codes

Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

List support tickets created on or after a certain date and in open state for a subscription
List support tickets for a subscription
List support tickets in open state for a subscription

List support tickets created on or after a certain date and in open state for a subscription

Sample Request

GET https://management.azure.com/subscriptions/subid/providers/Microsoft.Support/supportTickets?$filter=createdDate ge 2020-03-10T22:08:51Z and status eq 'Open'&api-version=2020-04-01

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/subid/providers/Microsoft.Support/supportTickets/testticket",
      "name": "testticket",
      "type": "Microsoft.Support/supportTickets",
      "properties": {
        "supportTicketId": "119120321001170",
        "description": "my description",
        "problemClassificationId": "/providers/Microsoft.Support/services/virtual_machine_service_guid/problemClassifications/problemClassification_guid",
        "problemClassificationDisplayName": "Connectivity / Cannot connect to virtual machine by using RDP or SSH",
        "severity": "moderate",
        "require24X7Response": false,
        "contactDetails": {
          "firstName": "abc",
          "lastName": "xyz",
          "preferredContactMethod": "email",
          "primaryEmailAddress": "abc@contoso.com",
          "preferredTimeZone": "Pacific Standard Time",
          "country": "usa",
          "preferredSupportLanguage": "en-US"
        },
        "technicalTicketDetails": {
          "resourceId": "/subscriptions/subid/resourceGroups/test/providers/Microsoft.Compute/virtualMachines/testserver"
        },
        "serviceLevelAgreement": {
          "startTime": "2020-03-11T21:36:18Z",
          "expirationTime": "2020-03-12T17:36:18Z",
          "slaMinutes": 240
        },
        "supportEngineer": {
          "emailAddress": "xyz@contoso.com"
        },
        "supportPlanType": "Premier",
        "title": "my title",
        "serviceId": "/providers/Microsoft.Support/services/virtual_machine_service_guid",
        "serviceDisplayName": "Virtual Machine running Linux",
        "status": "Open",
        "createdDate": "2020-03-11T21:36:18Z",
        "modifiedDate": "2020-03-12T21:36:23Z"
      }
    },
    {
      "id": "/subscriptions/subid/providers/Microsoft.Support/supportTickets/testticket2",
      "name": "testticket2",
      "type": "Microsoft.Support/supportTickets",
      "properties": {
        "supportTicketId": "118032014183771",
        "description": "This is a test - please ignore",
        "problemClassificationId": "/providers/Microsoft.Support/services/subscription_management_service_guid/problemClassifications/problemClassification_guid",
        "problemClassificationDisplayName": "Add or Edit VAT, TAX ID, or PO Number",
        "severity": "minimal",
        "require24X7Response": false,
        "contactDetails": {
          "firstName": "abc",
          "lastName": "xyz",
          "preferredContactMethod": "email",
          "primaryEmailAddress": "abc@contoso.com",
          "preferredTimeZone": "Pacific Standard Time",
          "country": "USA",
          "preferredSupportLanguage": "en-US"
        },
        "serviceLevelAgreement": {
          "startTime": "2020-03-11T21:36:18Z",
          "expirationTime": "2020-03-12T17:36:18Z",
          "slaMinutes": 240
        },
        "supportEngineer": {
          "emailAddress": "xyz@contoso.com"
        },
        "supportPlanType": "Premier",
        "title": "Test - please ignore",
        "serviceId": "/providers/Microsoft.Support/services/subscription_management_service_guid",
        "serviceDisplayName": "Subscription management",
        "status": "Open",
        "createdDate": "2020-03-11T21:36:18Z",
        "modifiedDate": "2020-03-12T21:36:18Z"
      }
    }
  ]
}

List support tickets for a subscription

Sample Request

GET https://management.azure.com/subscriptions/subid/providers/Microsoft.Support/supportTickets?api-version=2020-04-01

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/subid/providers/Microsoft.Support/supportTickets/testticket",
      "name": "testticket",
      "type": "Microsoft.Support/supportTickets",
      "properties": {
        "supportTicketId": "119120321001170",
        "description": "my description",
        "problemClassificationId": "/providers/Microsoft.Support/services/virtual_machine_service_guid/problemClassifications/problemClassification_guid",
        "problemClassificationDisplayName": "Connectivity / Cannot connect to virtual machine by using RDP or SSH",
        "severity": "moderate",
        "require24X7Response": false,
        "contactDetails": {
          "firstName": "abc",
          "lastName": "xyz",
          "preferredContactMethod": "email",
          "primaryEmailAddress": "abc@contoso.com",
          "preferredTimeZone": "Pacific Standard Time",
          "country": "usa",
          "preferredSupportLanguage": "en-US"
        },
        "technicalTicketDetails": {
          "resourceId": "/subscriptions/subid/resourceGroups/test/providers/Microsoft.Compute/virtualMachines/testserver"
        },
        "serviceLevelAgreement": {
          "startTime": "2020-03-20T21:36:18Z",
          "expirationTime": "2020-03-21T17:36:18Z",
          "slaMinutes": 240
        },
        "supportEngineer": {
          "emailAddress": "xyz@contoso.com"
        },
        "supportPlanType": "Premier",
        "title": "my title",
        "serviceId": "/providers/Microsoft.Support/services/virtual_machine_service_guid",
        "serviceDisplayName": "Virtual Machine running Linux",
        "status": "Open",
        "createdDate": "2020-03-20T21:36:18Z",
        "modifiedDate": "2020-03-20T21:36:23Z"
      }
    },
    {
      "id": "/subscriptions/subid/providers/Microsoft.Support/supportTickets/testticket2",
      "name": "testticket2",
      "type": "Microsoft.Support/supportTickets",
      "properties": {
        "supportTicketId": "118032014183771",
        "description": "This is a test - please ignore",
        "problemClassificationId": "/providers/Microsoft.Support/services/subscription_management_service_guid/problemClassifications/problemClassification_guid",
        "problemClassificationDisplayName": "Add or Edit VAT, TAX ID, or PO Number",
        "severity": "minimal",
        "require24X7Response": false,
        "contactDetails": {
          "firstName": "abc",
          "lastName": "xyz",
          "preferredContactMethod": "email",
          "primaryEmailAddress": "abc@contoso.com",
          "preferredTimeZone": "Pacific Standard Time",
          "country": "USA",
          "preferredSupportLanguage": "en-US"
        },
        "serviceLevelAgreement": {
          "startTime": "2020-03-20T21:36:18Z",
          "expirationTime": "2020-03-21T17:36:18Z",
          "slaMinutes": 240
        },
        "supportEngineer": {
          "emailAddress": "xyz@contoso.com"
        },
        "supportPlanType": "Premier",
        "title": "Test - please ignore",
        "serviceId": "/providers/Microsoft.Support/services/subscription_management_service_guid",
        "serviceDisplayName": "Subscription management",
        "status": "Open",
        "createdDate": "2020-03-20T21:36:18Z",
        "modifiedDate": "2020-03-20T21:36:23Z"
      }
    }
  ]
}

List support tickets in open state for a subscription

Sample Request

GET https://management.azure.com/subscriptions/subid/providers/Microsoft.Support/supportTickets?$filter=status eq 'Open'&api-version=2020-04-01

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/subid/providers/Microsoft.Support/supportTickets/testticket",
      "name": "testticket",
      "type": "Microsoft.Support/supportTickets",
      "properties": {
        "supportTicketId": "119120321001170",
        "description": "my description",
        "problemClassificationId": "/providers/Microsoft.Support/services/virtual_machine_service_guid/problemClassifications/problemClassification_guid",
        "problemClassificationDisplayName": "Connectivity / Cannot connect to virtual machine by using RDP or SSH",
        "severity": "moderate",
        "require24X7Response": false,
        "contactDetails": {
          "firstName": "abc",
          "lastName": "xyz",
          "preferredContactMethod": "email",
          "primaryEmailAddress": "abc@contoso.com",
          "preferredTimeZone": "Pacific Standard Time",
          "country": "usa",
          "preferredSupportLanguage": "en-US"
        },
        "technicalTicketDetails": {
          "resourceId": "/subscriptions/subid/resourceGroups/test/providers/Microsoft.Compute/virtualMachines/testserver"
        },
        "serviceLevelAgreement": {
          "startTime": "2020-03-20T21:36:18Z",
          "expirationTime": "2020-03-21T17:36:18Z",
          "slaMinutes": 240
        },
        "supportEngineer": {
          "emailAddress": "xyz@contoso.com"
        },
        "supportPlanType": "Premier",
        "title": "my title",
        "serviceId": "/providers/Microsoft.Support/services/virtual_machine_service_guid",
        "serviceDisplayName": "Virtual Machine running Linux",
        "status": "Open",
        "createdDate": "2020-03-20T21:36:18Z",
        "modifiedDate": "2020-03-20T21:36:23Z"
      }
    },
    {
      "id": "/subscriptions/subid/providers/Microsoft.Support/supportTickets/testticket2",
      "name": "testticket2",
      "type": "Microsoft.Support/supportTickets",
      "properties": {
        "supportTicketId": "118032014183771",
        "description": "This is a test - please ignore",
        "problemClassificationId": "/providers/Microsoft.Support/services/subscription_management_service_guid/problemClassifications/problemClassification_guid",
        "problemClassificationDisplayName": "Add or Edit VAT, TAX ID, or PO Number",
        "severity": "minimal",
        "require24X7Response": false,
        "contactDetails": {
          "firstName": "abc",
          "lastName": "xyz",
          "preferredContactMethod": "email",
          "primaryEmailAddress": "abc@contoso.com",
          "preferredTimeZone": "Pacific Standard Time",
          "country": "USA",
          "preferredSupportLanguage": "en-US"
        },
        "serviceLevelAgreement": {
          "startTime": "2020-03-20T21:36:18Z",
          "expirationTime": "2020-03-21T17:36:18Z",
          "slaMinutes": 240
        },
        "supportEngineer": {
          "emailAddress": "xyz@contoso.com"
        },
        "supportPlanType": "Premier",
        "title": "Test - please ignore",
        "serviceId": "/providers/Microsoft.Support/services/subscription_management_service_guid",
        "serviceDisplayName": "Subscription management",
        "status": "Open",
        "createdDate": "2020-03-20T21:36:18Z",
        "modifiedDate": "2020-03-20T21:36:23Z"
      }
    }
  ]
}

Definitions

ContactProfile

Contact information associated with the support ticket.

ExceptionResponse

The API error.

PreferredContactMethod

Preferred contact method.

QuotaChangeRequest

This property is required for providing the region and new quota limits.

QuotaTicketDetails

Additional set of information required for quota increase support ticket for certain quota types, e.g.: Virtual machine cores. Get complete details about Quota payload support request along with examples at Support quota request.

ServiceError

The API error details.

ServiceErrorDetail

The error details.

ServiceLevelAgreement

Service Level Agreement details for a support ticket.

SeverityLevel

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.

SupportEngineer

Support engineer information.

SupportTicketDetails

Object that represents SupportTicketDetails resource.

SupportTicketsListResult

Object that represents a collection of SupportTicket resources.

TechnicalTicketDetails

Additional information for technical support ticket.

ContactProfile

Contact information associated with the support ticket.

Name Type Description
additionalEmailAddresses
  • string[]

Additional email addresses listed will be copied on any correspondence about the support ticket.

country
  • string

Country of the user. This is the ISO 3166-1 alpha-3 code.

firstName
  • string

First name.

lastName
  • string

Last name.

phoneNumber
  • string

Phone number. This is required if preferred contact method is phone.

preferredContactMethod

Preferred contact method.

preferredSupportLanguage
  • string

Preferred language of support from Azure. Support languages vary based on the severity you choose for your support ticket. Learn more at Azure Severity and responsiveness. Use the standard language-country code. Valid values are 'en-us' for English, 'zh-hans' for Chinese, 'es-es' for Spanish, 'fr-fr' for French, 'ja-jp' for Japanese, 'ko-kr' for Korean, 'ru-ru' for Russian, 'pt-br' for Portuguese, 'it-it' for Italian, 'zh-tw' for Chinese and 'de-de' for German.

preferredTimeZone
  • string

Time zone of the user. This is the name of the time zone from Microsoft Time Zone Index Values.

primaryEmailAddress
  • string

Primary email address.

ExceptionResponse

The API error.

Name Type Description
error

The API error details.

PreferredContactMethod

Preferred contact method.

Name Type Description
email
  • string
phone
  • string

QuotaChangeRequest

This property is required for providing the region and new quota limits.

Name Type Description
payload
  • string

Payload of the quota increase request.

region
  • string

Region for which the quota increase request is being made.

QuotaTicketDetails

Additional set of information required for quota increase support ticket for certain quota types, e.g.: Virtual machine cores. Get complete details about Quota payload support request along with examples at Support quota request.

Name Type Description
quotaChangeRequestSubType
  • string

Required for certain quota types when there is a sub type, such as Batch, for which you are requesting a quota increase.

quotaChangeRequestVersion
  • string

Quota change request version.

quotaChangeRequests

This property is required for providing the region and new quota limits.

ServiceError

The API error details.

Name Type Description
code
  • string

The error code.

details

The list of error details.

message
  • string

The error message.

target
  • string

The target of the error.

ServiceErrorDetail

The error details.

Name Type Description
code
  • string

The error code.

message
  • string

The error message.

target
  • string

The target of the error.

ServiceLevelAgreement

Service Level Agreement details for a support ticket.

Name Type Description
expirationTime
  • string

Time in UTC (ISO 8601 format) when the service level agreement expires.

slaMinutes
  • integer

Service Level Agreement in minutes.

startTime
  • string

Time in UTC (ISO 8601 format) when the service level agreement starts.

SeverityLevel

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.

Name Type Description
critical
  • string
highestcriticalimpact
  • string
minimal
  • string
moderate
  • string

SupportEngineer

Support engineer information.

Name Type Description
emailAddress
  • string

Email address of the Azure Support engineer assigned to the support ticket.

SupportTicketDetails

Object that represents SupportTicketDetails resource.

Name Type Description
id
  • string

Id of the resource.

name
  • string

Name of the resource.

properties.contactDetails

Contact information of the user requesting to create a support ticket.

properties.createdDate
  • string

Time in UTC (ISO 8601 format) when the support ticket was created.

properties.description
  • string

Detailed description of the question or issue.

properties.enrollmentId
  • string

Enrollment Id associated with the support ticket.

properties.modifiedDate
  • string

Time in UTC (ISO 8601 format) when the support ticket was last modified.

properties.problemClassificationDisplayName
  • string

Localized name of problem classification.

properties.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.

properties.problemStartTime
  • string

Time in UTC (ISO 8601 format) when the problem started.

properties.quotaTicketDetails

Additional ticket details associated with a quota support ticket request.

properties.require24X7Response
  • boolean

Indicates if this requires a 24x7 response from Azure.

properties.serviceDisplayName
  • string

Localized name of the Azure service.

properties.serviceId
  • string

This is the resource Id of the Azure service resource associated with the support ticket.

properties.serviceLevelAgreement

Service Level Agreement information for this support ticket.

properties.severity

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.

properties.status
  • string

Status of the support ticket.

properties.supportEngineer

Information about the support engineer working on this support ticket.

properties.supportPlanType
  • string

Support plan type associated with the support ticket.

properties.supportTicketId
  • string

System generated support ticket Id that is unique.

properties.technicalTicketDetails

Additional ticket details associated with a technical support ticket request.

properties.title
  • string

Title of the support ticket.

type
  • string

Type of the resource 'Microsoft.Support/supportTickets'.

SupportTicketsListResult

Object that represents a collection of SupportTicket resources.

Name Type Description
nextLink
  • string

The URI to fetch the next page of SupportTicket resources.

value

List of SupportTicket resources.

TechnicalTicketDetails

Additional information for technical support ticket.

Name Type Description
resourceId
  • string

This is the resource Id of the Azure service resource (For example: A virtual machine resource or an HDInsight resource) for which the support ticket is created.