Overview:
Azure Help API programmatically helps you troubleshoot Azure issues and provides access to rich and powerful self-help solutions and diagnostics. Using the API, you can perform the following operations:
| Solution Discovery | Lists the diagnostics for an Azure issue based on the prerequisites. |
| Diagnostics | Create and Get diagnostics for issues with Azure resources based on prerequisites (see below). |
Prerequisites for Diagnostics:
The diagnostics API is called after solutions discovery and returns diagnostic info for your Azure issue.
You must have reader access role at the resource level to create diagnostics.
'RequiredParameterSets' from Discovery Solutions API response has to be passed via 'properties.insights.additionalParameters' as a key-value pairs to Diagnostics Api.",
+ "description": "Diagnostics tells you precisely the root cause of the issue and how to address it. You can get diagnostics once you discover and identify the relevant solution for your Azure issue.
You can create diagnostics using the ‘solutionId’ from Solution Discovery API response and ‘additionalParameters’
Note: ‘requiredParameterSets’ from Solutions Discovery API response must be passed via ‘additionalParameters’ as an input to Diagnostics API",
"operationId": "Diagnostics_Create",
"x-ms-long-running-operation": true,
"x-ms-long-running-operation-options": {
@@ -172,7 +172,7 @@
"tags": [
"diagnostics"
],
- "description": "
Overview:
Azure Help API programmatically helps you troubleshoot Azure issues and provides access to rich and powerful self-help solutions and diagnostics. Using the API, you can perform the following operations:
| Solution Discovery | Lists the diagnostics for an Azure issue based on the prerequisites. |
| Diagnostics | Create and Get diagnostics for issues with Azure resources based on prerequisites (see below). |
Prerequisites for Diagnostics:
The diagnostics API is called after solutions discovery and returns diagnostic info for your Azure issue.
You must have reader access role at the resource level to get the diagnostics.
'RequiredParameterSets' from Discovery Solutions API response has to be passed via 'properties.insights.additionalParameters' as a key-value pairs to Diagnostics Api.",
+ "description": "Get the diagnostics using the 'diagnosticsResourceName' you chose while creating the diagnostic.",
"operationId": "Diagnostics_Get",
"parameters": [
{
@@ -211,7 +211,7 @@
"tags": [
"discoverySolutions"
],
- "description": "
Overview:
Azure Help API programmatically helps you troubleshoot Azure issues and provides access to rich and powerful self-help solutions and diagnostics. Using the API, you can perform the following operations:
| Solution Discovery | Lists the diagnostics for an Azure issue based on the prerequisites (see below). |
| Diagnostics | Create and Get diagnostics for issues with Azure resources. |
Prerequisites for solution discovery:
You can call the API to discover solutions with the following inputs:
i. Required inputs: resourceUri.
ii. Optional input: problemClassificationId.
This API enables discovery of diagnostics for a defined list of Azure support issues, and is not supported for all ProblemClassificationId(s) at the moment. For ProblemClassificationId(s) that are not supported, the API response will not return any diagnostics. You can use ProblemClassifications API to get the problem categories and ProblemClassificationId(s) reference.
You must have reader access role at the resource level to get the solutions.
Note: 'RequiredParameterSets' from Discovery Solutions API response has to be passed via 'properties.insights.additionalParameters' as an input to Diagnostics API.