Microsoft.Help (stable:2023-06-01)

2025/09/12 • 5 new, 5 deleted methods

Operations_List (new)
Description :  Returns list of operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Help/operations
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the resource provider ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action" ,
Required: False ,
}
string ,
isDataAction:
{
Description: Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations. ,
Required: False ,
}
boolean ,
display:
{
Description: Localized display information for this particular operation. ,
Required: False ,
}
{
provider:
{
Description: The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute". ,
Required: False ,
}
string ,
resource:
{
Description: The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections". ,
Required: False ,
}
string ,
operation:
{
Description: The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine". ,
Required: False ,
}
string ,
description:
{
Description: The short, localized friendly description of the operation; suitable for tool tips and detailed views. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" ,
Enum:
{
user: No description available. ,
system: No description available. ,
user,system: No description available. ,
}
,
Required: False ,
}
enum ,
actionType:
{
Description: Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. ,
Enum:
{
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results (if there are any). ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Diagnostics_CheckNameAvailability (new)
Description :  This API is used to check the uniqueness of a resource name used for a diagnostic check.
Reference :  Link ¶

⚼ Request

POST:  /{scope}/providers/Microsoft.Help/checkNameAvailability
{
scope:
{
Description: This is an extension resource provider and only resource level extension is supported at the moment. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
CheckNameAvailabilityRequest:
{
Description: The required parameters for availability check. ,
Required: False ,
}
{
name:
{
Description: The name of the resource for which availability needs to be checked. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
nameAvailable:
{
Description: Returns true or false depending on the availability of the name ,
Required: False ,
}
boolean ,
reason:
{
Description: Reason for why value is not available. This field is returned if nameAvailable is false. ,
Required: False ,
}
string ,
message:
{
Description: Gets an error message explaining the 'reason' value with more details. This field is returned iif nameAvailable is false. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Diagnostics_Create (new)
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
Reference :  Link ¶

⚼ Request

PUT:  /{scope}/providers/Microsoft.Help/diagnostics/{diagnosticsResourceName}
{
scope:
{
Description: This is an extension resource provider and only resource level extension is supported at the moment. ,
Required: True ,
}
string ,
diagnosticsResourceName:
{
Description: Unique resource name for insight resources ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
diagnosticResourceRequest:
{
Description: The required request body for this insightResource invocation. ,
Required: False ,
}
{
properties:
{
Description: Diagnostic Resource properties. ,
Required: False ,
}
{
globalParameters:
{
Description: Global parameters that can be passed to all solutionIds. ,
Required: False ,
}
object ,
insights:
{
Description: SolutionIds that are needed to be invoked. ,
Required: False ,
}
[
{
solutionId:
{
Description: Solution Id to invoke. ,
Required: False ,
}
string ,
additionalParameters:
{
Description: Additional parameters required to invoke the solutionId. ,
Required: False ,
}
object ,
}
,
]
,
acceptedAt:
{
Description: Diagnostic Request Accepted time. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Status of diagnostic provisioning. ,
Enum:
{
Succeeded: All Diagnostics in the Batch succeeded. ,
PartialComplete: Some Diagnostics are still running or failed. ,
Failed: All Diagnostics failed to run. ,
Canceled: When Diagnostic request gets canceled. ,
}
,
Required: False ,
}
enum ,
diagnostics:
{
Description: Array of Diagnostics. ,
Required: False ,
}
[
{
solutionId:
{
Description: Solution Id ,
Required: False ,
}
string ,
status:
{
Description: Denotes the status of the diagnostic resource. ,
Enum:
{
Failed: Diagnostic creation failed. ,
MissingInputs: Request is missing required inputs to run. ,
Running: Diagnostic is still running. ,
Succeeded: Diagnostic creation succeeded. ,
Timeout: Diagnostic was timed out. ,
}
,
Required: False ,
}
enum ,
insights:
{
Description: The problems (if any) detected by this insight. ,
Required: False ,
}
[
{
id:
{
Description: Article id. ,
Required: False ,
}
string ,
title:
{
Description: This insight's title. ,
Required: False ,
}
string ,
results:
{
Description: Detailed result content. ,
Required: False ,
}
string ,
importanceLevel:
{
Description: Importance level of the insight. ,
Enum:
{
Critical: A critical insight has been found after running the diagnostic. ,
Warning: A warning insight has been found after running the diagnostic. ,
Information: An information insight has been found after running the diagnostic. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
error:
{
Description: Error definition. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
type:
{
Description: Service specific error type which serves as additional context for the error herein. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Diagnostic Resource properties. ,
Required: False ,
}
{
globalParameters:
{
Description: Global parameters that can be passed to all solutionIds. ,
Required: False ,
}
object ,
insights:
{
Description: SolutionIds that are needed to be invoked. ,
Required: False ,
}
[
{
solutionId:
{
Description: Solution Id to invoke. ,
Required: False ,
}
string ,
additionalParameters:
{
Description: Additional parameters required to invoke the solutionId. ,
Required: False ,
}
object ,
}
,
]
,
acceptedAt:
{
Description: Diagnostic Request Accepted time. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Status of diagnostic provisioning. ,
Enum:
{
Succeeded: All Diagnostics in the Batch succeeded. ,
PartialComplete: Some Diagnostics are still running or failed. ,
Failed: All Diagnostics failed to run. ,
Canceled: When Diagnostic request gets canceled. ,
}
,
Required: False ,
}
enum ,
diagnostics:
{
Description: Array of Diagnostics. ,
Required: False ,
}
[
{
solutionId:
{
Description: Solution Id ,
Required: False ,
}
string ,
status:
{
Description: Denotes the status of the diagnostic resource. ,
Enum:
{
Failed: Diagnostic creation failed. ,
MissingInputs: Request is missing required inputs to run. ,
Running: Diagnostic is still running. ,
Succeeded: Diagnostic creation succeeded. ,
Timeout: Diagnostic was timed out. ,
}
,
Required: False ,
}
enum ,
insights:
{
Description: The problems (if any) detected by this insight. ,
Required: False ,
}
[
{
id:
{
Description: Article id. ,
Required: False ,
}
string ,
title:
{
Description: This insight's title. ,
Required: False ,
}
string ,
results:
{
Description: Detailed result content. ,
Required: False ,
}
string ,
importanceLevel:
{
Description: Importance level of the insight. ,
Enum:
{
Critical: A critical insight has been found after running the diagnostic. ,
Warning: A warning insight has been found after running the diagnostic. ,
Information: An information insight has been found after running the diagnostic. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
error:
{
Description: Error definition. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
type:
{
Description: Service specific error type which serves as additional context for the error herein. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Diagnostic Resource properties. ,
Required: False ,
}
{
globalParameters:
{
Description: Global parameters that can be passed to all solutionIds. ,
Required: False ,
}
object ,
insights:
{
Description: SolutionIds that are needed to be invoked. ,
Required: False ,
}
[
{
solutionId:
{
Description: Solution Id to invoke. ,
Required: False ,
}
string ,
additionalParameters:
{
Description: Additional parameters required to invoke the solutionId. ,
Required: False ,
}
object ,
}
,
]
,
acceptedAt:
{
Description: Diagnostic Request Accepted time. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Status of diagnostic provisioning. ,
Enum:
{
Succeeded: All Diagnostics in the Batch succeeded. ,
PartialComplete: Some Diagnostics are still running or failed. ,
Failed: All Diagnostics failed to run. ,
Canceled: When Diagnostic request gets canceled. ,
}
,
Required: False ,
}
enum ,
diagnostics:
{
Description: Array of Diagnostics. ,
Required: False ,
}
[
{
solutionId:
{
Description: Solution Id ,
Required: False ,
}
string ,
status:
{
Description: Denotes the status of the diagnostic resource. ,
Enum:
{
Failed: Diagnostic creation failed. ,
MissingInputs: Request is missing required inputs to run. ,
Running: Diagnostic is still running. ,
Succeeded: Diagnostic creation succeeded. ,
Timeout: Diagnostic was timed out. ,
}
,
Required: False ,
}
enum ,
insights:
{
Description: The problems (if any) detected by this insight. ,
Required: False ,
}
[
{
id:
{
Description: Article id. ,
Required: False ,
}
string ,
title:
{
Description: This insight's title. ,
Required: False ,
}
string ,
results:
{
Description: Detailed result content. ,
Required: False ,
}
string ,
importanceLevel:
{
Description: Importance level of the insight. ,
Enum:
{
Critical: A critical insight has been found after running the diagnostic. ,
Warning: A warning insight has been found after running the diagnostic. ,
Information: An information insight has been found after running the diagnostic. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
error:
{
Description: Error definition. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
type:
{
Description: Service specific error type which serves as additional context for the error herein. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Diagnostics_Get (new)
Description :  Get the diagnostics using the 'diagnosticsResourceName' you chose while creating the diagnostic.
Reference :  Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.Help/diagnostics/{diagnosticsResourceName}
{
scope:
{
Description: This is an extension resource provider and only resource level extension is supported at the moment. ,
Required: True ,
}
string ,
diagnosticsResourceName:
{
Description: Unique resource name for insight resources ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Diagnostic Resource properties. ,
Required: False ,
}
{
globalParameters:
{
Description: Global parameters that can be passed to all solutionIds. ,
Required: False ,
}
object ,
insights:
{
Description: SolutionIds that are needed to be invoked. ,
Required: False ,
}
[
{
solutionId:
{
Description: Solution Id to invoke. ,
Required: False ,
}
string ,
additionalParameters:
{
Description: Additional parameters required to invoke the solutionId. ,
Required: False ,
}
object ,
}
,
]
,
acceptedAt:
{
Description: Diagnostic Request Accepted time. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Status of diagnostic provisioning. ,
Enum:
{
Succeeded: All Diagnostics in the Batch succeeded. ,
PartialComplete: Some Diagnostics are still running or failed. ,
Failed: All Diagnostics failed to run. ,
Canceled: When Diagnostic request gets canceled. ,
}
,
Required: False ,
}
enum ,
diagnostics:
{
Description: Array of Diagnostics. ,
Required: False ,
}
[
{
solutionId:
{
Description: Solution Id ,
Required: False ,
}
string ,
status:
{
Description: Denotes the status of the diagnostic resource. ,
Enum:
{
Failed: Diagnostic creation failed. ,
MissingInputs: Request is missing required inputs to run. ,
Running: Diagnostic is still running. ,
Succeeded: Diagnostic creation succeeded. ,
Timeout: Diagnostic was timed out. ,
}
,
Required: False ,
}
enum ,
insights:
{
Description: The problems (if any) detected by this insight. ,
Required: False ,
}
[
{
id:
{
Description: Article id. ,
Required: False ,
}
string ,
title:
{
Description: This insight's title. ,
Required: False ,
}
string ,
results:
{
Description: Detailed result content. ,
Required: False ,
}
string ,
importanceLevel:
{
Description: Importance level of the insight. ,
Enum:
{
Critical: A critical insight has been found after running the diagnostic. ,
Warning: A warning insight has been found after running the diagnostic. ,
Information: An information insight has been found after running the diagnostic. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
error:
{
Description: Error definition. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
type:
{
Description: Service specific error type which serves as additional context for the error herein. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DiscoverySolution_List (new)
Description :  Solutions Discovery is the initial point of entry within Help API, which helps you identify the relevant solutions for your Azure issue.

You can discover solutions using resourceUri OR resourceUri + problemClassificationId.

We will do our best in returning relevant diagnostics for your Azure issue.

Get the problemClassificationId(s) using this [reference](https://learn.microsoft.com/rest/api/support/problem-classifications/list?tabs=HTTP).

Note: ‘requiredParameterSets’ from Solutions Discovery API response must be passed via ‘additionalParameters’ as an input to Diagnostics API.
Reference :  Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.Help/discoverySolutions
{
scope:
{
Description: This is an extension resource provider and only resource level extension is supported at the moment. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
$filter:
{
Description: Can be used to filter solutionIds by 'ProblemClassificationId'. The filter supports only 'and' and 'eq' operators. Example: $filter=ProblemClassificationId eq '1ddda5b4-cf6c-4d4f-91ad-bc38ab0e811e' and ProblemClassificationId eq '0a9673c2-7af6-4e19-90d3-4ee2461076d9'. ,
Required: False ,
}
string ,
$skiptoken:
{
Description: Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of solution metadata. ,
Required: False ,
}
[
{
properties:
{
Description: Solution metadata Resource properties. ,
Required: False ,
}
{
solutionId:
{
Description: Solution Id. ,
Required: False ,
}
string ,
solutionType:
{
Description: Solution Type. ,
Required: False ,
}
string ,
description:
{
Description: A detailed description of solution. ,
Required: False ,
}
string ,
requiredParameterSets:
{
Description: Required parameters for invoking this particular solution. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link used to get the next page of solution metadata. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Operations_List (removed)
Description :  Returns list of operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Help/operations
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the resource provider ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action" ,
Required: False ,
}
string ,
isDataAction:
{
Description: Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations. ,
Required: False ,
}
boolean ,
display:
{
Description: Localized display information for this particular operation. ,
Required: False ,
}
{
provider:
{
Description: The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute". ,
Required: False ,
}
string ,
resource:
{
Description: The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections". ,
Required: False ,
}
string ,
operation:
{
Description: The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine". ,
Required: False ,
}
string ,
description:
{
Description: The short, localized friendly description of the operation; suitable for tool tips and detailed views. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" ,
Enum:
{
user: No description available. ,
system: No description available. ,
user,system: No description available. ,
}
,
Required: False ,
}
enum ,
actionType:
{
Description: Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. ,
Enum:
{
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results (if there are any). ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Diagnostics_CheckNameAvailability (removed)
Description :  This API is used to check the uniqueness of a resource name used for a diagnostic check.
Reference :  Link ¶

⚼ Request

POST:  /{scope}/providers/Microsoft.Help/checkNameAvailability
{
scope:
{
Description: This is an extension resource provider and only resource level extension is supported at the moment. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
CheckNameAvailabilityRequest:
{
Description: The required parameters for availability check. ,
Required: False ,
}
{
name:
{
Description: The name of the resource for which availability needs to be checked. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
nameAvailable:
{
Description: Returns true or false depending on the availability of the name ,
Required: False ,
}
boolean ,
reason:
{
Description: Reason for why value is not available. This field is returned if nameAvailable is false. ,
Required: False ,
}
string ,
message:
{
Description: Gets an error message explaining the 'reason' value with more details. This field is returned iif nameAvailable is false. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Diagnostics_Create (removed)
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
Reference :  Link ¶

⚼ Request

PUT:  /{scope}/providers/Microsoft.Help/diagnostics/{diagnosticsResourceName}
{
scope:
{
Description: This is an extension resource provider and only resource level extension is supported at the moment. ,
Required: True ,
}
string ,
diagnosticsResourceName:
{
Description: Unique resource name for insight resources ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
diagnosticResourceRequest:
{
Description: The required request body for this insightResource invocation. ,
Required: False ,
}
{
properties:
{
Description: Diagnostic Resource properties. ,
Required: False ,
}
{
globalParameters:
{
Description: Global parameters that can be passed to all solutionIds. ,
Required: False ,
}
object ,
insights:
{
Description: SolutionIds that are needed to be invoked. ,
Required: False ,
}
[
{
solutionId:
{
Description: Solution Id to invoke. ,
Required: False ,
}
string ,
additionalParameters:
{
Description: Additional parameters required to invoke the solutionId. ,
Required: False ,
}
object ,
}
,
]
,
acceptedAt:
{
Description: Diagnostic Request Accepted time. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Status of diagnostic provisioning. ,
Enum:
{
Succeeded: All Diagnostics in the Batch succeeded. ,
PartialComplete: Some Diagnostics are still running or failed. ,
Failed: All Diagnostics failed to run. ,
Canceled: When Diagnostic request gets canceled. ,
}
,
Required: False ,
}
enum ,
diagnostics:
{
Description: Array of Diagnostics. ,
Required: False ,
}
[
{
solutionId:
{
Description: Solution Id ,
Required: False ,
}
string ,
status:
{
Description: Denotes the status of the diagnostic resource. ,
Enum:
{
Failed: Diagnostic creation failed. ,
MissingInputs: Request is missing required inputs to run. ,
Running: Diagnostic is still running. ,
Succeeded: Diagnostic creation succeeded. ,
Timeout: Diagnostic was timed out. ,
}
,
Required: False ,
}
enum ,
insights:
{
Description: The problems (if any) detected by this insight. ,
Required: False ,
}
[
{
id:
{
Description: Article id. ,
Required: False ,
}
string ,
title:
{
Description: This insight's title. ,
Required: False ,
}
string ,
results:
{
Description: Detailed result content. ,
Required: False ,
}
string ,
importanceLevel:
{
Description: Importance level of the insight. ,
Enum:
{
Critical: A critical insight has been found after running the diagnostic. ,
Warning: A warning insight has been found after running the diagnostic. ,
Information: An information insight has been found after running the diagnostic. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
error:
{
Description: Error definition. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
type:
{
Description: Service specific error type which serves as additional context for the error herein. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Diagnostic Resource properties. ,
Required: False ,
}
{
globalParameters:
{
Description: Global parameters that can be passed to all solutionIds. ,
Required: False ,
}
object ,
insights:
{
Description: SolutionIds that are needed to be invoked. ,
Required: False ,
}
[
{
solutionId:
{
Description: Solution Id to invoke. ,
Required: False ,
}
string ,
additionalParameters:
{
Description: Additional parameters required to invoke the solutionId. ,
Required: False ,
}
object ,
}
,
]
,
acceptedAt:
{
Description: Diagnostic Request Accepted time. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Status of diagnostic provisioning. ,
Enum:
{
Succeeded: All Diagnostics in the Batch succeeded. ,
PartialComplete: Some Diagnostics are still running or failed. ,
Failed: All Diagnostics failed to run. ,
Canceled: When Diagnostic request gets canceled. ,
}
,
Required: False ,
}
enum ,
diagnostics:
{
Description: Array of Diagnostics. ,
Required: False ,
}
[
{
solutionId:
{
Description: Solution Id ,
Required: False ,
}
string ,
status:
{
Description: Denotes the status of the diagnostic resource. ,
Enum:
{
Failed: Diagnostic creation failed. ,
MissingInputs: Request is missing required inputs to run. ,
Running: Diagnostic is still running. ,
Succeeded: Diagnostic creation succeeded. ,
Timeout: Diagnostic was timed out. ,
}
,
Required: False ,
}
enum ,
insights:
{
Description: The problems (if any) detected by this insight. ,
Required: False ,
}
[
{
id:
{
Description: Article id. ,
Required: False ,
}
string ,
title:
{
Description: This insight's title. ,
Required: False ,
}
string ,
results:
{
Description: Detailed result content. ,
Required: False ,
}
string ,
importanceLevel:
{
Description: Importance level of the insight. ,
Enum:
{
Critical: A critical insight has been found after running the diagnostic. ,
Warning: A warning insight has been found after running the diagnostic. ,
Information: An information insight has been found after running the diagnostic. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
error:
{
Description: Error definition. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
type:
{
Description: Service specific error type which serves as additional context for the error herein. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Diagnostic Resource properties. ,
Required: False ,
}
{
globalParameters:
{
Description: Global parameters that can be passed to all solutionIds. ,
Required: False ,
}
object ,
insights:
{
Description: SolutionIds that are needed to be invoked. ,
Required: False ,
}
[
{
solutionId:
{
Description: Solution Id to invoke. ,
Required: False ,
}
string ,
additionalParameters:
{
Description: Additional parameters required to invoke the solutionId. ,
Required: False ,
}
object ,
}
,
]
,
acceptedAt:
{
Description: Diagnostic Request Accepted time. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Status of diagnostic provisioning. ,
Enum:
{
Succeeded: All Diagnostics in the Batch succeeded. ,
PartialComplete: Some Diagnostics are still running or failed. ,
Failed: All Diagnostics failed to run. ,
Canceled: When Diagnostic request gets canceled. ,
}
,
Required: False ,
}
enum ,
diagnostics:
{
Description: Array of Diagnostics. ,
Required: False ,
}
[
{
solutionId:
{
Description: Solution Id ,
Required: False ,
}
string ,
status:
{
Description: Denotes the status of the diagnostic resource. ,
Enum:
{
Failed: Diagnostic creation failed. ,
MissingInputs: Request is missing required inputs to run. ,
Running: Diagnostic is still running. ,
Succeeded: Diagnostic creation succeeded. ,
Timeout: Diagnostic was timed out. ,
}
,
Required: False ,
}
enum ,
insights:
{
Description: The problems (if any) detected by this insight. ,
Required: False ,
}
[
{
id:
{
Description: Article id. ,
Required: False ,
}
string ,
title:
{
Description: This insight's title. ,
Required: False ,
}
string ,
results:
{
Description: Detailed result content. ,
Required: False ,
}
string ,
importanceLevel:
{
Description: Importance level of the insight. ,
Enum:
{
Critical: A critical insight has been found after running the diagnostic. ,
Warning: A warning insight has been found after running the diagnostic. ,
Information: An information insight has been found after running the diagnostic. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
error:
{
Description: Error definition. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
type:
{
Description: Service specific error type which serves as additional context for the error herein. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Diagnostics_Get (removed)
Description :  Get the diagnostics using the 'diagnosticsResourceName' you chose while creating the diagnostic.
Reference :  Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.Help/diagnostics/{diagnosticsResourceName}
{
scope:
{
Description: This is an extension resource provider and only resource level extension is supported at the moment. ,
Required: True ,
}
string ,
diagnosticsResourceName:
{
Description: Unique resource name for insight resources ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Diagnostic Resource properties. ,
Required: False ,
}
{
globalParameters:
{
Description: Global parameters that can be passed to all solutionIds. ,
Required: False ,
}
object ,
insights:
{
Description: SolutionIds that are needed to be invoked. ,
Required: False ,
}
[
{
solutionId:
{
Description: Solution Id to invoke. ,
Required: False ,
}
string ,
additionalParameters:
{
Description: Additional parameters required to invoke the solutionId. ,
Required: False ,
}
object ,
}
,
]
,
acceptedAt:
{
Description: Diagnostic Request Accepted time. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Status of diagnostic provisioning. ,
Enum:
{
Succeeded: All Diagnostics in the Batch succeeded. ,
PartialComplete: Some Diagnostics are still running or failed. ,
Failed: All Diagnostics failed to run. ,
Canceled: When Diagnostic request gets canceled. ,
}
,
Required: False ,
}
enum ,
diagnostics:
{
Description: Array of Diagnostics. ,
Required: False ,
}
[
{
solutionId:
{
Description: Solution Id ,
Required: False ,
}
string ,
status:
{
Description: Denotes the status of the diagnostic resource. ,
Enum:
{
Failed: Diagnostic creation failed. ,
MissingInputs: Request is missing required inputs to run. ,
Running: Diagnostic is still running. ,
Succeeded: Diagnostic creation succeeded. ,
Timeout: Diagnostic was timed out. ,
}
,
Required: False ,
}
enum ,
insights:
{
Description: The problems (if any) detected by this insight. ,
Required: False ,
}
[
{
id:
{
Description: Article id. ,
Required: False ,
}
string ,
title:
{
Description: This insight's title. ,
Required: False ,
}
string ,
results:
{
Description: Detailed result content. ,
Required: False ,
}
string ,
importanceLevel:
{
Description: Importance level of the insight. ,
Enum:
{
Critical: A critical insight has been found after running the diagnostic. ,
Warning: A warning insight has been found after running the diagnostic. ,
Information: An information insight has been found after running the diagnostic. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
error:
{
Description: Error definition. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
type:
{
Description: Service specific error type which serves as additional context for the error herein. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DiscoverySolution_List (removed)
Description :  Solutions Discovery is the initial point of entry within Help API, which helps you identify the relevant solutions for your Azure issue.

You can discover solutions using resourceUri OR resourceUri + problemClassificationId.

We will do our best in returning relevant diagnostics for your Azure issue.

Get the problemClassificationId(s) using this [reference](https://learn.microsoft.com/rest/api/support/problem-classifications/list?tabs=HTTP).

Note: ‘requiredParameterSets’ from Solutions Discovery API response must be passed via ‘additionalParameters’ as an input to Diagnostics API.
Reference :  Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.Help/discoverySolutions
{
scope:
{
Description: This is an extension resource provider and only resource level extension is supported at the moment. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
$filter:
{
Description: Can be used to filter solutionIds by 'ProblemClassificationId'. The filter supports only 'and' and 'eq' operators. Example: $filter=ProblemClassificationId eq '1ddda5b4-cf6c-4d4f-91ad-bc38ab0e811e' and ProblemClassificationId eq '0a9673c2-7af6-4e19-90d3-4ee2461076d9'. ,
Required: False ,
}
string ,
$skiptoken:
{
Description: Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of solution metadata. ,
Required: False ,
}
[
{
properties:
{
Description: Solution metadata Resource properties. ,
Required: False ,
}
{
solutionId:
{
Description: Solution Id. ,
Required: False ,
}
string ,
solutionType:
{
Description: Solution Type. ,
Required: False ,
}
string ,
description:
{
Description: A detailed description of solution. ,
Required: False ,
}
string ,
requiredParameterSets:
{
Description: Required parameters for invoking this particular solution. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link used to get the next page of solution metadata. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}