Azure Help REST API Reference

  • Article

Microsoft seeks to empower all its customers to achieve more and Microsoft Azure is no different. With Azure, we hope to enable you to drive limitless innovation. Our self-help support offerings offer you new ways to engage with the Azure support experience and put the power of our Azure resources in your hands. Help API provides you with access to rich and powerful self-help Azure solutions that enable you to troubleshoot Azure issues from your preferred UI without the need to create a Support ticket. By using Help API, you can get access to insight diagnostics, Troubleshooters, and other powerful solutions for your Azure resource and subscription. These solutions are curated by Azure engineers that will expedite your troubleshooting experiences across Billing, Subscription Management and technical issues. This reference documentation serves as a guide for using Help API and specific reference information for each REST operation.

Role Prerequisites:

  • To use Help API you must use your AAD token.

  • You must have access to the subscription scope.

  • For diagnostics, you must have reader access role for the resource on which the diagnostics is executed.

Solution discovery and execution steps:

  • Discovery solution API is the initial point of entry to discover the solution metadata mapped to the subscription or resource

  • Once the solution/diagnostics is determined based on the description field in the solution discovery response, you can execute the solution using Diagnostics or Solutions API

Operation Group Description
Operations List all the available Help API REST operations
Discovery solution Lists the relevant Azure diagnostics and Solutions using problemClassificationId AND resourceUri or resourceType
Diagnostics Create and list diagnostics for an Azure resource.
Solutions Create, update and list Azure Solutions for the selected subscription or resource. In this version we will support technical issues , billing/ subscription management issues (non-tenant)
Troubleshooters  Create and list Troubleshooters as one of the components of Solutions for the specific subscription and resource scope

Legal disclosure:This API connects to Azure Services. Your use of this API and the Azure Services it connects to are governed by the agreement under which you obtained Azure Services. SeeMicrosoft Azure Legal Information | Microsoft Azure for more informationfor more information.

Support in other languages and interfaces

Apart from support in REST API, self help api support is available in the following interfaces and languages:

This API connects to Azure Services. Your use of this API and the Azure Services it connects to are governed by the agreement under which you obtained the Azure Services. See Microsoft Azure Legal Information | Microsoft Azure for more information.