Microsoft.Help (preview:2023-09-01)

2025/09/12 • 13 new, 13 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). ,
Format: uri ,
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 ,
}
,
]
,
}
,
}
CheckNameAvailability_Post (new)
Description :  This API is used to check the uniqueness of a resource name used for a diagnostic, troubleshooter or solutions
Reference :  Link ¶

⚼ Request

POST:  /{scope}/providers/Microsoft.Help/checkNameAvailability
{
scope:
{
Description: scope = resourceUri of affected resource.
For example: /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read ,
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 :  Creates a diagnostic for the specific resource using solutionId and requiredInputs* from discovery solutions.
Diagnostics are powerful solutions that access product resources or other relevant data and provide the root cause of the issue and the steps to address the issue.

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

⚼ Request

PUT:  /{scope}/providers/Microsoft.Help/diagnostics/{diagnosticsResourceName}
{
scope:
{
Description: scope = resourceUri of affected resource.
For example: /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read ,
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 is an optional map which can be used to add key and value to request body to improve the diagnostics results ,
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. ,
Running: All Diagnostics are still running. ,
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 is an optional map which can be used to add key and value to request body to improve the diagnostics results ,
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. ,
Running: All Diagnostics are still running. ,
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 is an optional map which can be used to add key and value to request body to improve the diagnostics results ,
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. ,
Running: All Diagnostics are still running. ,
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: scope = resourceUri of affected resource.
For example: /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read ,
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 is an optional map which can be used to add key and value to request body to improve the diagnostics results ,
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. ,
Running: All Diagnostics are still running. ,
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 :  Lists the relevant Azure diagnostics and solutions using [problemClassification API](https://learn.microsoft.com/rest/api/support/problem-classifications/list?tabs=HTTP)) AND resourceUri or resourceType.
Discovery Solutions is the initial entry point within Help API, which identifies relevant Azure diagnostics and solutions.

Required Input : problemClassificationId (Use the [problemClassification API](https://learn.microsoft.com/rest/api/support/problem-classifications/list?tabs=HTTP))
Optional input: resourceUri OR resource Type

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

⚼ Request

GET:  /{scope}/providers/Microsoft.Help/discoverySolutions
{
scope:
{
Description: scope = resourceUri of affected resource.
For example: /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
$filter:
{
Description: 'ProblemClassificationId' is a mandatory filter to get solutions ids. It also supports optional 'ResourceType' and 'SolutionType' filters. The [$filter](https://learn.microsoft.com/en-us/odata/webapi/first-odata-api#filter) supports only 'and', 'or' and 'eq' operators. Example: $filter=ProblemClassificationId eq '1ddda5b4-cf6c-4d4f-91ad-bc38ab0e811e' ,
Required: False ,
}
string ,
$skiptoken:
{
Description: Skiptoken is only used if a previous operation returned a partial result. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of metadata. ,
Required: False ,
}
[
{
properties:
{
Description: Solution metadata Resource properties. ,
Required: False ,
}
{
solutions:
{
Description: List of metadata. ,
Required: False ,
}
[
{
solutionId:
{
Description: Solution Id. ,
Required: False ,
}
string ,
solutionType:
{
Description: Solution Type. ,
Enum:
{
Diagnostics: Diagnostics resource type. ,
Solutions: Solutions resource type. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: A detailed description of solution. ,
Required: False ,
}
string ,
requiredInputs:
{
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 ,
}
,
]
,
}
,
}
Solution_Create (new)
Description :  Creates a solution for the specific Azure resource or subscription using the inputs ‘solutionId and requiredInputs’ from discovery solutions.
Azure solutions comprise a comprehensive library of self-help resources that have been thoughtfully curated by Azure engineers to aid customers in resolving typical troubleshooting issues. These solutions encompass (1.) dynamic and context-aware diagnostics, guided troubleshooting wizards, and data visualizations, (2.) rich instructional video tutorials and illustrative diagrams and images, and (3.) thoughtfully assembled textual troubleshooting instructions. All these components are seamlessly converged into unified solutions tailored to address a specific support problem area. Each solution type may require one or more ‘requiredParameters’ that are required to execute the individual solution component. In the absence of the ‘requiredParameters’ it is likely that some of the solutions might fail execution, and you might see an empty response.

Note:
1. ‘requiredInputs’ from Discovery solutions response must be passed via ‘parameters’ in the request body of Solutions API.
2. ‘requiredParameters’ from the Solutions response is the same as ‘ additionalParameters’ in the request for diagnostics
3. ‘requiredParameters’ from the Solutions response is the same as ‘properties.parameters’ in the request for Troubleshooters
Reference :  Link ¶

⚼ Request

PUT:  /{scope}/providers/Microsoft.Help/solutions/{solutionResourceName}
{
scope:
{
Description: scope = resourceUri of affected resource.
For example: /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read ,
Required: True ,
}
string ,
solutionResourceName:
{
Description: Solution resource Name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
solutionRequestBody:
{
Description: The required request body for this solution resource creation. ,
Required: False ,
}
{
properties:
{
Description: Solution result ,
Required: False ,
}
{
triggerCriteria:
{
Description: Solution request trigger criteria ,
Required: False ,
}
[
{
name:
{
Description: Trigger criterion name. ,
Enum:
{
SolutionId: No description available. ,
ProblemClassificationId: No description available. ,
ReplacementKey: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: Trigger criterion value. ,
Required: False ,
}
string ,
}
,
]
,
parameters:
{
Description: Client input parameters to run Solution ,
Required: False ,
}
object ,
solutionId:
{
Description: Solution Id to identify single solution. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Status of solution provisioning. ,
Enum:
{
Succeeded: All Solutions in the Batch succeeded. ,
PartialComplete: Some Solutions are still running or failed. ,
Failed: All Solutions failed to run. ,
Running: All Solutions are still running. ,
Canceled: When Solutions request gets canceled. ,
}
,
Required: False ,
}
enum ,
title:
{
Description: The title. ,
Required: False ,
}
string ,
content:
{
Description: The HTML content that needs to be rendered and shown to customer. ,
Required: False ,
}
string ,
replacementMaps:
{
Description: Solution replacement maps. ,
Required: False ,
}
{
webResults:
{
Description: Solution AzureKB results ,
Required: False ,
}
[
{
replacementKey:
{
Description: Place holder used in HTML Content replace control with the content ,
Required: False ,
}
string ,
searchResults:
{
Description: AzureKB search results ,
Required: False ,
}
[
{
solutionId:
{
Description: Unique id of the result. ,
Required: False ,
}
string ,
content:
{
Description: Content of the search result. ,
Required: False ,
}
string ,
title:
{
Description: Title of the search result. ,
Required: False ,
}
string ,
confidence:
{
Description: Confidence of the search result. ,
Enum:
{
Low: No description available. ,
Medium: No description available. ,
High: No description available. ,
}
,
Required: False ,
}
enum ,
source:
{
Description: Source of the search result. ,
Required: False ,
}
string ,
resultType:
{
Description: Result type of the search result. ,
Enum:
{
Community: No description available. ,
Documentation: No description available. ,
}
,
Required: False ,
}
enum ,
rank:
{
Description: rank of the search result ,
Format: int32 ,
Required: False ,
}
integer ,
link:
{
Description: Link to the document. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
diagnostics:
{
Description: Solution diagnostics results. ,
Required: False ,
}
[
{
solutionId:
{
Description: Solution Id to identify single Solutions Diagnostic ,
Required: False ,
}
string ,
status:
{
Description: The status of the resource. ,
Enum:
{
Failed: No description available. ,
MissingInputs: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: Details of the status ,
Required: False ,
}
string ,
replacementKey:
{
Description: Place holder used in HTML Content replace control with the content ,
Required: False ,
}
string ,
requiredParameters:
{
Description: Required parameters of this item ,
Required: False ,
}
[
string ,
]
,
insights:
{
Description: Diagnostic insights ,
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 ,
}
,
]
,
}
,
]
,
troubleshooters:
{
Description: Solutions Troubleshooters ,
Required: False ,
}
[
{
solutionId:
{
Description: Solution Id to identify single Solutions Troubleshooter ,
Required: False ,
}
string ,
title:
{
Description: Troubleshooter title ,
Required: False ,
}
string ,
summary:
{
Description: Troubleshooter summary ,
Required: False ,
}
string ,
}
,
]
,
metricsBasedCharts:
{
Description: Solution metrics based charts ,
Required: False ,
}
[
{
name:
{
Description: Chart name ,
Required: False ,
}
string ,
aggregationType:
{
Description: Allowed values are Sum, Avg, Count, Min, Max. Default is Sum ,
Enum:
{
Sum: No description available. ,
Avg: No description available. ,
Count: No description available. ,
Min: No description available. ,
Max: No description available. ,
}
,
Required: False ,
}
enum ,
timeSpanDuration:
{
Description: Time span duration ,
Required: False ,
}
string ,
title:
{
Description: Chart title ,
Required: False ,
}
string ,
filterGroup:
{
Description: Filter group ,
Required: False ,
}
{
filter:
{
Description: List of filters ,
Required: False ,
}
[
{
name:
{
Description: Filter name ,
Required: False ,
}
string ,
values:
{
Description: Filter values ,
Required: False ,
}
string ,
operator:
{
Description: Filter operator ,
Required: False ,
}
string ,
}
,
]
,
}
,
replacementKey:
{
Description: Place holder used in HTML Content replace control with the content ,
Required: False ,
}
string ,
}
,
]
,
videos:
{
Description: Video solutions, which have the power to engage the customer by stimulating their senses ,
Required: False ,
}
[
{
replacementKey:
{
Description: Place holder used in HTML Content replace control with the insight content ,
Required: False ,
}
string ,
}
,
]
,
videoGroups:
{
Description: Group of Videos ,
Required: False ,
}
[
{
videos:
{
Description: List of videos will be shown to customers ,
Required: False ,
}
[
{
src:
{
Description: Link to the video ,
Required: False ,
}
string ,
title:
{
Description: Title of the video ,
Required: False ,
}
string ,
}
,
]
,
replacementKey:
{
Description: Place holder used in HTML Content replace control with the insight content ,
Required: False ,
}
string ,
}
,
]
,
}
,
sections:
{
Description: List of section object. ,
Required: False ,
}
[
{
title:
{
Description: Solution sections title. ,
Required: False ,
}
string ,
content:
{
Description: Solution sections content. ,
Required: False ,
}
string ,
replacementMaps:
{
Description: Solution replacement maps. ,
Required: False ,
}
{
webResults:
{
Description: Solution AzureKB results ,
Required: False ,
}
[
{
replacementKey:
{
Description: Place holder used in HTML Content replace control with the content ,
Required: False ,
}
string ,
searchResults:
{
Description: AzureKB search results ,
Required: False ,
}
[
{
solutionId:
{
Description: Unique id of the result. ,
Required: False ,
}
string ,
content:
{
Description: Content of the search result. ,
Required: False ,
}
string ,
title:
{
Description: Title of the search result. ,
Required: False ,
}
string ,
confidence:
{
Description: Confidence of the search result. ,
Enum:
{
Low: No description available. ,
Medium: No description available. ,
High: No description available. ,
}
,
Required: False ,
}
enum ,
source:
{
Description: Source of the search result. ,
Required: False ,
}
string ,
resultType:
{
Description: Result type of the search result. ,
Enum:
{
Community: No description available. ,
Documentation: No description available. ,
}
,
Required: False ,
}
enum ,
rank:
{
Description: rank of the search result ,
Format: int32 ,
Required: False ,
}
integer ,
link:
{
Description: Link to the document. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
diagnostics:
{
Description: Solution diagnostics results. ,
Required: False ,
}
[
{
solutionId:
{
Description: Solution Id to identify single Solutions Diagnostic ,
Required: False ,
}
string ,
status:
{
Description: The status of the resource. ,
Enum:
{
Failed: No description available. ,
MissingInputs: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: Details of the status ,
Required: False ,
}
string ,
replacementKey:
{
Description: Place holder used in HTML Content replace control with the content ,
Required: False ,
}
string ,
requiredParameters:
{
Description: Required parameters of this item ,
Required: False ,
}
[
string ,
]
,
insights:
{
Description: Diagnostic insights ,
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 ,
}
,
]
,
}
,
]
,
troubleshooters:
{
Description: Solutions Troubleshooters ,
Required: False ,
}
[
{
solutionId:
{
Description: Solution Id to identify single Solutions Troubleshooter ,
Required: False ,
}
string ,
title:
{
Description: Troubleshooter title ,
Required: False ,
}
string ,
summary:
{
Description: Troubleshooter summary ,
Required: False ,
}
string ,
}
,
]
,
metricsBasedCharts:
{
Description: Solution metrics based charts ,
Required: False ,
}
[
{
name:
{
Description: Chart name ,
Required: False ,
}
string ,
aggregationType:
{
Description: Allowed values are Sum, Avg, Count, Min, Max. Default is Sum ,
Enum:
{
Sum: No description available. ,
Avg: No description available. ,
Count: No description available. ,
Min: No description available. ,
Max: No description available. ,
}
,
Required: False ,
}
enum ,
timeSpanDuration:
{
Description: Time span duration ,
Required: False ,
}
string ,
title:
{
Description: Chart title ,
Required: False ,
}
string ,
filterGroup:
{
Description: Filter group ,
Required: False ,
}
{
filter:
{
Description: List of filters ,
Required: False ,
}
[
{
name:
{
Description: Filter name ,
Required: False ,
}
string ,
values:
{
Description: Filter values ,
Required: False ,
}
string ,
operator:
{
Description: Filter operator ,
Required: False ,
}
string ,
}
,
]
,
}
,
replacementKey:
{
Description: Place holder used in HTML Content replace control with the content ,
Required: False ,
}
string ,
}
,
]
,
videos:
{
Description: Video solutions, which have the power to engage the customer by stimulating their senses ,
Required: False ,
}
[
{
replacementKey:
{
Description: Place holder used in HTML Content replace control with the insight content ,
Required: False ,
}
string ,
}
,
]
,
videoGroups:
{
Description: Group of Videos ,
Required: False ,
}
[
{
videos:
{
Description: List of videos will be shown to customers ,
Required: False ,
}
[
{
src:
{
Description: Link to the video ,
Required: False ,
}
string ,
title:
{
Description: Title of the video ,
Required: False ,
}
string ,
}
,
]
,
replacementKey:
{
Description: Place holder used in HTML Content replace control with the insight content ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Solution result ,
Required: False ,
}
{
triggerCriteria:
{
Description: Solution request trigger criteria ,
Required: False ,
}
[
{
name:
{
Description: Trigger criterion name. ,
Enum:
{
SolutionId: No description available. ,
ProblemClassificationId: No description available. ,
ReplacementKey: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: Trigger criterion value. ,
Required: False ,
}
string ,
}
,
]
,
parameters:
{
Description: Client input parameters to run Solution ,
Required: False ,
}
object ,
solutionId:
{
Description: Solution Id to identify single solution. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Status of solution provisioning. ,
Enum:
{
Succeeded: All Solutions in the Batch succeeded. ,
PartialComplete: Some Solutions are still running or failed. ,
Failed: All Solutions failed to run. ,
Running: All Solutions are still running. ,
Canceled: When Solutions request gets canceled. ,
}
,
Required: False ,
}
enum ,
title:
{
Description: The title. ,
Required: False ,
}
string ,
content:
{
Description: The HTML content that needs to be rendered and shown to customer. ,
Required: False ,
}
string ,
replacementMaps:
{
Description: Solution replacement maps. ,
Required: False ,
}
{
webResults:
{
Description: Solution AzureKB results ,
Required: False ,
}
[
{
replacementKey:
{
Description: Place holder used in HTML Content replace control with the content ,
Required: False ,
}
string ,
searchResults:
{
Description: AzureKB search results ,
Required: False ,
}
[
{
solutionId:
{
Description: Unique id of the result. ,
Required: False ,
}
string ,
content:
{
Description: Content of the search result. ,
Required: False ,
}
string ,
title:
{
Description: Title of the search result. ,
Required: False ,
}
string ,
confidence:
{
Description: Confidence of the search result. ,
Enum:
{
Low: No description available. ,
Medium: No description available. ,
High: No description available. ,
}
,
Required: False ,
}
enum ,
source:
{
Description: Source of the search result. ,
Required: False ,
}
string ,
resultType:
{
Description: Result type of the search result. ,
Enum:
{
Community: No description available. ,
Documentation: No description available. ,
}
,
Required: False ,
}
enum ,
rank:
{
Description: rank of the search result ,
Format: int32 ,
Required: False ,
}
integer ,
link:
{
Description: Link to the document. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
diagnostics:
{
Description: Solution diagnostics results. ,
Required: False ,
}
[
{
solutionId:
{
Description: Solution Id to identify single Solutions Diagnostic ,
Required: False ,
}
string ,
status:
{
Description: The status of the resource. ,
Enum:
{
Failed: No description available. ,
MissingInputs: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: Details of the status ,
Required: False ,
}
string ,
replacementKey:
{
Description: Place holder used in HTML Content replace control with the content ,
Required: False ,
}
string ,
requiredParameters:
{
Description: Required parameters of this item ,
Required: False ,
}
[
string ,
]
,
insights:
{
Description: Diagnostic insights ,
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 ,
}
,
]
,
}
,
]
,
troubleshooters:
{
Description: Solutions Troubleshooters ,
Required: False ,
}
[
{
solutionId:
{
Description: Solution Id to identify single Solutions Troubleshooter ,
Required: False ,
}
string ,
title:
{
Description: Troubleshooter title ,
Required: False ,
}
string ,
summary:
{
Description: Troubleshooter summary ,
Required: False ,
}
string ,
}
,
]
,
metricsBasedCharts:
{
Description: Solution metrics based charts ,
Required: False ,
}
[
{
name:
{
Description: Chart name ,
Required: False ,
}
string ,
aggregationType:
{
Description: Allowed values are Sum, Avg, Count, Min, Max. Default is Sum ,
Enum:
{
Sum: No description available. ,
Avg: No description available. ,
Count: No description available. ,
Min: No description available. ,
Max: No description available. ,
}
,
Required: False ,
}
enum ,
timeSpanDuration:
{
Description: Time span duration ,
Required: False ,
}
string ,
title:
{
Description: Chart title ,
Required: False ,
}
string ,
filterGroup:
{
Description: Filter group ,
Required: False ,
}
{
filter:
{
Description: List of filters ,
Required: False ,
}
[
{
name:
{
Description: Filter name ,
Required: False ,
}
string ,
values:
{
Description: Filter values ,
Required: False ,
}
string ,
operator:
{
Description: Filter operator ,
Required: False ,
}
string ,
}
,
]
,
}
,
replacementKey:
{
Description: Place holder used in HTML Content replace control with the content ,
Required: False ,
}
string ,
}
,
]
,
videos:
{
Description: Video solutions, which have the power to engage the customer by stimulating their senses ,
Required: False ,
}
[
{
replacementKey:
{
Description: Place holder used in HTML Content replace control with the insight content ,
Required: False ,
}
string ,
}
,
]
,
videoGroups:
{
Description: Group of Videos ,
Required: False ,
}
[
{
videos:
{
Description: List of videos will be shown to customers ,
Required: False ,
}
[
{
src:
{
Description: Link to the video ,
Required: False ,
}
string ,
title:
{
Description: Title of the video ,
Required: False ,
}
string ,
}
,
]
,
replacementKey:
{
Description: Place holder used in HTML Content replace control with the insight content ,
Required: False ,
}
string ,
}
,
]
,
}
,
sections:
{
Description: List of section object. ,
Required: False ,
}
[
{
title:
{
Description: Solution sections title. ,
Required: False ,
}
string ,
content:
{
Description: Solution sections content. ,
Required: False ,
}
string ,
replacementMaps:
{
Description: Solution replacement maps. ,
Required: False ,
}
{
webResults:
{
Description: Solution AzureKB results ,
Required: False ,
}
[
{
replacementKey:
{
Description: Place holder used in HTML Content replace control with the content ,
Required: False ,
}
string ,
searchResults:
{
Description: AzureKB search results ,
Required: False ,
}
[
{
solutionId:
{
Description: Unique id of the result. ,
Required: False ,
}
string ,
content:
{
Description: Content of the search result. ,
Required: False ,
}
string ,
title:
{
Description: Title of the search result. ,
Required: False ,
}
string ,
confidence:
{
Description: Confidence of the search result. ,
Enum:
{
Low: No description available. ,
Medium: No description available. ,
High: No description available. ,
}
,
Required: False ,
}
enum ,
source:
{
Description: Source of the search result. ,
Required: False ,
}
string ,
resultType:
{
Description: Result type of the search result. ,
Enum:
{
Community: No description available. ,
Documentation: No description available. ,
}
,
Required: False ,
}
enum ,
rank:
{
Description: rank of the search result ,
Format: int32 ,
Required: False ,
}
integer ,
link:
{
Description: Link to the document. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
diagnostics:
{
Description: Solution diagnostics results. ,
Required: False ,
}
[
{
solutionId:
{
Description: Solution Id to identify single Solutions Diagnostic ,
Required: False ,
}
string ,
status:
{
Description: The status of the resource. ,
Enum:
{
Failed: No description available. ,
MissingInputs: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: Details of the status ,
Required: False ,
}
string ,
replacementKey:
{
Description: Place holder used in HTML Content replace control with the content ,
Required: False ,
}
string ,
requiredParameters:
{
Description: Required parameters of this item ,
Required: False ,
}
[
string ,
]
,
insights:
{
Description: Diagnostic insights ,
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 ,
}
,
]
,
}
,
]
,
troubleshooters:
{
Description: Solutions Troubleshooters ,
Required: False ,
}
[
{
solutionId:
{
Description: Solution Id to identify single Solutions Troubleshooter ,
Required: False ,
}
string ,
title:
{
Description: Troubleshooter title ,
Required: False ,
}
string ,
summary:
{
Description: Troubleshooter summary ,
Required: False ,
}
string ,
}
,
]
,
metricsBasedCharts:
{
Description: Solution metrics based charts ,
Required: False ,
}
[
{
name:
{
Description: Chart name ,
Required: False ,
}
string ,
aggregationType:
{
Description: Allowed values are Sum, Avg, Count, Min, Max. Default is Sum ,
Enum:
{
Sum: No description available. ,
Avg: No description available. ,
Count: No description available. ,
Min: No description available. ,
Max: No description available. ,
}
,
Required: False ,
}
enum ,
timeSpanDuration:
{
Description: Time span duration ,
Required: False ,
}
string ,
title:
{
Description: Chart title ,
Required: False ,
}
string ,
filterGroup:
{
Description: Filter group ,
Required: False ,
}
{
filter:
{
Description: List of filters ,
Required: False ,
}
[
{
name:
{
Description: Filter name ,
Required: False ,
}
string ,
values:
{
Description: Filter values ,
Required: False ,
}
string ,
operator:
{
Description: Filter operator ,
Required: False ,
}
string ,
}
,
]
,
}
,
replacementKey:
{
Description: Place holder used in HTML Content replace control with the content ,
Required: False ,
}
string ,
}
,
]
,
videos:
{
Description: Video solutions, which have the power to engage the customer by stimulating their senses ,
Required: False ,
}
[
{
replacementKey:
{
Description: Place holder used in HTML Content replace control with the insight content ,
Required: False ,
}
string ,
}
,
]
,
videoGroups:
{
Description: Group of Videos ,
Required: False ,
}
[
{
videos:
{
Description: List of videos will be shown to customers ,
Required: False ,
}
[
{
src:
{
Description: Link to the video ,
Required: False ,
}
string ,
title:
{
Description: Title of the video ,
Required: False ,
}
string ,
}
,
]
,
replacementKey:
{
Description: Place holder used in HTML Content replace control with the insight content ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Solution result ,
Required: False ,
}
{
triggerCriteria:
{
Description: Solution request trigger criteria ,
Required: False ,
}
[
{
name:
{
Description: Trigger criterion name. ,
Enum:
{
SolutionId: No description available. ,
ProblemClassificationId: No description available. ,
ReplacementKey: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: Trigger criterion value. ,
Required: False ,
}
string ,
}
,
]
,
parameters:
{
Description: Client input parameters to run Solution ,
Required: False ,
}
object ,
solutionId:
{
Description: Solution Id to identify single solution. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Status of solution provisioning. ,
Enum:
{
Succeeded: All Solutions in the Batch succeeded. ,
PartialComplete: Some Solutions are still running or failed. ,
Failed: All Solutions failed to run. ,
Running: All Solutions are still running. ,
Canceled: When Solutions request gets canceled. ,
}
,
Required: False ,
}
enum ,
title:
{
Description: The title. ,
Required: False ,
}
string ,
content:
{
Description: The HTML content that needs to be rendered and shown to customer. ,
Required: False ,
}
string ,
replacementMaps:
{
Description: Solution replacement maps. ,
Required: False ,
}
{
webResults:
{
Description: Solution AzureKB results ,
Required: False ,
}
[
{
replacementKey:
{
Description: Place holder used in HTML Content replace control with the content ,
Required: False ,
}
string ,
searchResults:
{
Description: AzureKB search results ,
Required: False ,
}
[
{
solutionId:
{
Description: Unique id of the result. ,
Required: False ,
}
string ,
content:
{
Description: Content of the search result. ,
Required: False ,
}
string ,
title:
{
Description: Title of the search result. ,
Required: False ,
}
string ,
confidence:
{
Description: Confidence of the search result. ,
Enum:
{
Low: No description available. ,
Medium: No description available. ,
High: No description available. ,
}
,
Required: False ,
}
enum ,
source:
{
Description: Source of the search result. ,
Required: False ,
}
string ,
resultType:
{
Description: Result type of the search result. ,
Enum:
{
Community: No description available. ,
Documentation: No description available. ,
}
,
Required: False ,
}
enum ,
rank:
{
Description: rank of the search result ,
Format: int32 ,
Required: False ,
}
integer ,
link:
{
Description: Link to the document. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
diagnostics:
{
Description: Solution diagnostics results. ,
Required: False ,
}
[
{
solutionId:
{
Description: Solution Id to identify single Solutions Diagnostic ,
Required: False ,
}
string ,
status:
{
Description: The status of the resource. ,
Enum:
{
Failed: No description available. ,
MissingInputs: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: Details of the status ,
Required: False ,
}
string ,
replacementKey:
{
Description: Place holder used in HTML Content replace control with the content ,
Required: False ,
}
string ,
requiredParameters:
{
Description: Required parameters of this item ,
Required: False ,
}
[
string ,
]
,
insights:
{
Description: Diagnostic insights ,
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 ,
}
,
]
,
}
,
]
,
troubleshooters:
{
Description: Solutions Troubleshooters ,
Required: False ,
}
[
{
solutionId:
{
Description: Solution Id to identify single Solutions Troubleshooter ,
Required: False ,
}
string ,
title:
{
Description: Troubleshooter title ,
Required: False ,
}
string ,
summary:
{
Description: Troubleshooter summary ,
Required: False ,
}
string ,
}
,
]
,
metricsBasedCharts:
{
Description: Solution metrics based charts ,
Required: False ,
}
[
{
name:
{
Description: Chart name ,
Required: False ,
}
string ,
aggregationType:
{
Description: Allowed values are Sum, Avg, Count, Min, Max. Default is Sum ,
Enum:
{
Sum: No description available. ,
Avg: No description available. ,
Count: No description available. ,
Min: No description available. ,
Max: No description available. ,
}
,
Required: False ,
}
enum ,
timeSpanDuration:
{
Description: Time span duration ,
Required: False ,
}
string ,
title:
{
Description: Chart title ,
Required: False ,
}
string ,
filterGroup:
{
Description: Filter group ,
Required: False ,
}
{
filter:
{
Description: List of filters ,
Required: False ,
}
[
{
name:
{
Description: Filter name ,
Required: False ,
}
string ,
values:
{
Description: Filter values ,
Required: False ,
}
string ,
operator:
{
Description: Filter operator ,
Required: False ,
}
string ,
}
,
]
,
}
,
replacementKey:
{
Description: Place holder used in HTML Content replace control with the content ,
Required: False ,
}
string ,
}
,
]
,
videos:
{
Description: Video solutions, which have the power to engage the customer by stimulating their senses ,
Required: False ,
}
[
{
replacementKey:
{
Description: Place holder used in HTML Content replace control with the insight content ,
Required: False ,
}
string ,
}
,
]
,
videoGroups:
{
Description: Group of Videos ,
Required: False ,
}
[
{
videos:
{
Description: List of videos will be shown to customers ,
Required: False ,
}
[
{
src:
{
Description: Link to the video ,
Required: False ,
}
string ,
title:
{
Description: Title of the video ,
Required: False ,
}
string ,
}
,
]
,
replacementKey:
{
Description: Place holder used in HTML Content replace control with the insight content ,
Required: False ,
}
string ,
}
,
]
,
}
,
sections:
{
Description: List of section object. ,
Required: False ,
}
[
{
title:
{
Description: Solution sections title. ,
Required: False ,
}
string ,
content:
{
Description: Solution sections content. ,
Required: False ,
}
string ,
replacementMaps:
{
Description: Solution replacement maps. ,
Required: False ,
}
{
webResults:
{
Description: Solution AzureKB results ,
Required: False ,
}
[
{
replacementKey:
{
Description: Place holder used in HTML Content replace control with the content ,
Required: False ,
}
string ,
searchResults:
{
Description: AzureKB search results ,
Required: False ,
}
[
{
solutionId:
{
Description: Unique id of the result. ,
Required: False ,
}
string ,
content:
{
Description: Content of the search result. ,
Required: False ,
}
string ,
title:
{
Description: Title of the search result. ,
Required: False ,
}
string ,
confidence:
{
Description: Confidence of the search result. ,
Enum:
{
Low: No description available. ,
Medium: No description available. ,
High: No description available. ,
}
,
Required: False ,
}
enum ,
source:
{
Description: Source of the search result. ,
Required: False ,
}
string ,
resultType:
{
Description: Result type of the search result. ,
Enum:
{
Community: No description available. ,
Documentation: No description available. ,
}
,
Required: False ,
}
enum ,
rank:
{
Description: rank of the search result ,
Format: int32 ,
Required: False ,
}
integer ,
link:
{
Description: Link to the document. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
diagnostics:
{
Description: Solution diagnostics results. ,
Required: False ,
}
[
{
solutionId:
{
Description: Solution Id to identify single Solutions Diagnostic ,
Required: False ,
}
string ,
status:
{
Description: The status of the resource. ,
Enum:
{
Failed: No description available. ,
MissingInputs: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: Details of the status ,
Required: False ,
}
string ,
replacementKey:
{
Description: Place holder used in HTML Content replace control with the content ,
Required: False ,
}
string ,
requiredParameters:
{
Description: Required parameters of this item ,
Required: False ,
}
[
string ,
]
,
insights:
{
Description: Diagnostic insights ,
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 ,
}
,
]
,
}
,
]
,
troubleshooters:
{
Description: Solutions Troubleshooters ,
Required: False ,
}
[
{
solutionId:
{
Description: Solution Id to identify single Solutions Troubleshooter ,
Required: False ,
}
string ,
title:
{
Description: Troubleshooter title ,
Required: False ,
}
string ,
summary:
{
Description: Troubleshooter summary ,
Required: False ,
}
string ,
}
,
]
,
metricsBasedCharts:
{
Description: Solution metrics based charts ,
Required: False ,
}
[
{
name:
{
Description: Chart name ,
Required: False ,
}
string ,
aggregationType:
{
Description: Allowed values are Sum, Avg, Count, Min, Max. Default is Sum ,
Enum:
{
Sum: No description available. ,
Avg: No description available. ,
Count: No description available. ,
Min: No description available. ,
Max: No description available. ,
}
,
Required: False ,
}
enum ,
timeSpanDuration:
{
Description: Time span duration ,
Required: False ,
}
string ,
title:
{
Description: Chart title ,
Required: False ,
}
string ,
filterGroup:
{
Description: Filter group ,
Required: False ,
}
{
filter:
{
Description: List of filters ,
Required: False ,
}
[
{
name:
{
Description: Filter name ,
Required: False ,
}
string ,
values:
{
Description: Filter values ,
Required: False ,
}
string ,
operator:
{
Description: Filter operator ,
Required: False ,
}
string ,
}
,
]
,
}
,
replacementKey:
{
Description: Place holder used in HTML Content replace control with the content ,
Required: False ,
}
string ,
}
,
]
,
videos:
{
Description: Video solutions, which have the power to engage the customer by stimulating their senses ,
Required: False ,
}
[
{
replacementKey:
{
Description: Place holder used in HTML Content replace control with the insight content ,
Required: False ,
}
string ,
}
,
]
,
videoGroups:
{
Description: Group of Videos ,
Required: False ,
}
[
{
videos:
{
Description: List of videos will be shown to customers ,
Required: False ,
}
[
{
src:
{
Description: Link to the video ,
Required: False ,
}
string ,
title:
{
Description: Title of the video ,
Required: False ,
}
string ,
}
,
]
,
replacementKey:
{
Description: Place holder used in HTML Content replace control with the insight content ,
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 ,
}
,
]
,
}
,
}
Solution_Get (new)
Description :  Get the solution using the applicable solutionResourceName while creating the solution.
Reference :  Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.Help/solutions/{solutionResourceName}
{
scope:
{
Description: scope = resourceUri of affected resource.
For example: /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read ,
Required: True ,
}
string ,
solutionResourceName:
{
Description: Solution resource Name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Solution result ,
Required: False ,
}
{
triggerCriteria:
{
Description: Solution request trigger criteria ,
Required: False ,
}
[
{
name:
{
Description: Trigger criterion name. ,
Enum:
{
SolutionId: No description available. ,
ProblemClassificationId: No description available. ,
ReplacementKey: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: Trigger criterion value. ,
Required: False ,
}
string ,
}
,
]
,
parameters:
{
Description: Client input parameters to run Solution ,
Required: False ,
}
object ,
solutionId:
{
Description: Solution Id to identify single solution. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Status of solution provisioning. ,
Enum:
{
Succeeded: All Solutions in the Batch succeeded. ,
PartialComplete: Some Solutions are still running or failed. ,
Failed: All Solutions failed to run. ,
Running: All Solutions are still running. ,
Canceled: When Solutions request gets canceled. ,
}
,
Required: False ,
}
enum ,
title:
{
Description: The title. ,
Required: False ,
}
string ,
content:
{
Description: The HTML content that needs to be rendered and shown to customer. ,
Required: False ,
}
string ,
replacementMaps:
{
Description: Solution replacement maps. ,
Required: False ,
}
{
webResults:
{
Description: Solution AzureKB results ,
Required: False ,
}
[
{
replacementKey:
{
Description: Place holder used in HTML Content replace control with the content ,
Required: False ,
}
string ,
searchResults:
{
Description: AzureKB search results ,
Required: False ,
}
[
{
solutionId:
{
Description: Unique id of the result. ,
Required: False ,
}
string ,
content:
{
Description: Content of the search result. ,
Required: False ,
}
string ,
title:
{
Description: Title of the search result. ,
Required: False ,
}
string ,
confidence:
{
Description: Confidence of the search result. ,
Enum:
{
Low: No description available. ,
Medium: No description available. ,
High: No description available. ,
}
,
Required: False ,
}
enum ,
source:
{
Description: Source of the search result. ,
Required: False ,
}
string ,
resultType:
{
Description: Result type of the search result. ,
Enum:
{
Community: No description available. ,
Documentation: No description available. ,
}
,
Required: False ,
}
enum ,
rank:
{
Description: rank of the search result ,
Format: int32 ,
Required: False ,
}
integer ,
link:
{
Description: Link to the document. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
diagnostics:
{
Description: Solution diagnostics results. ,
Required: False ,
}
[
{
solutionId:
{
Description: Solution Id to identify single Solutions Diagnostic ,
Required: False ,
}
string ,
status:
{
Description: The status of the resource. ,
Enum:
{
Failed: No description available. ,
MissingInputs: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: Details of the status ,
Required: False ,
}
string ,
replacementKey:
{
Description: Place holder used in HTML Content replace control with the content ,
Required: False ,
}
string ,
requiredParameters:
{
Description: Required parameters of this item ,
Required: False ,
}
[
string ,
]
,
insights:
{
Description: Diagnostic insights ,
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 ,
}
,
]
,
}
,
]
,
troubleshooters:
{
Description: Solutions Troubleshooters ,
Required: False ,
}
[
{
solutionId:
{
Description: Solution Id to identify single Solutions Troubleshooter ,
Required: False ,
}
string ,
title:
{
Description: Troubleshooter title ,
Required: False ,
}
string ,
summary:
{
Description: Troubleshooter summary ,
Required: False ,
}
string ,
}
,
]
,
metricsBasedCharts:
{
Description: Solution metrics based charts ,
Required: False ,
}
[
{
name:
{
Description: Chart name ,
Required: False ,
}
string ,
aggregationType:
{
Description: Allowed values are Sum, Avg, Count, Min, Max. Default is Sum ,
Enum:
{
Sum: No description available. ,
Avg: No description available. ,
Count: No description available. ,
Min: No description available. ,
Max: No description available. ,
}
,
Required: False ,
}
enum ,
timeSpanDuration:
{
Description: Time span duration ,
Required: False ,
}
string ,
title:
{
Description: Chart title ,
Required: False ,
}
string ,
filterGroup:
{
Description: Filter group ,
Required: False ,
}
{
filter:
{
Description: List of filters ,
Required: False ,
}
[
{
name:
{
Description: Filter name ,
Required: False ,
}
string ,
values:
{
Description: Filter values ,
Required: False ,
}
string ,
operator:
{
Description: Filter operator ,
Required: False ,
}
string ,
}
,
]
,
}
,
replacementKey:
{
Description: Place holder used in HTML Content replace control with the content ,
Required: False ,
}
string ,
}
,
]
,
videos:
{
Description: Video solutions, which have the power to engage the customer by stimulating their senses ,
Required: False ,
}
[
{
replacementKey:
{
Description: Place holder used in HTML Content replace control with the insight content ,
Required: False ,
}
string ,
}
,
]
,
videoGroups:
{
Description: Group of Videos ,
Required: False ,
}
[
{
videos:
{
Description: List of videos will be shown to customers ,
Required: False ,
}
[
{
src:
{
Description: Link to the video ,
Required: False ,
}
string ,
title:
{
Description: Title of the video ,
Required: False ,
}
string ,
}
,
]
,
replacementKey:
{
Description: Place holder used in HTML Content replace control with the insight content ,
Required: False ,
}
string ,
}
,
]
,
}
,
sections:
{
Description: List of section object. ,
Required: False ,
}
[
{
title:
{
Description: Solution sections title. ,
Required: False ,
}
string ,
content:
{
Description: Solution sections content. ,
Required: False ,
}
string ,
replacementMaps:
{
Description: Solution replacement maps. ,
Required: False ,
}
{
webResults:
{
Description: Solution AzureKB results ,
Required: False ,
}
[
{
replacementKey:
{
Description: Place holder used in HTML Content replace control with the content ,
Required: False ,
}
string ,
searchResults:
{
Description: AzureKB search results ,
Required: False ,
}
[
{
solutionId:
{
Description: Unique id of the result. ,
Required: False ,
}
string ,
content:
{
Description: Content of the search result. ,
Required: False ,
}
string ,
title:
{
Description: Title of the search result. ,
Required: False ,
}
string ,
confidence:
{
Description: Confidence of the search result. ,
Enum:
{
Low: No description available. ,
Medium: No description available. ,
High: No description available. ,
}
,
Required: False ,
}
enum ,
source:
{
Description: Source of the search result. ,
Required: False ,
}
string ,
resultType:
{
Description: Result type of the search result. ,
Enum:
{
Community: No description available. ,
Documentation: No description available. ,
}
,
Required: False ,
}
enum ,
rank:
{
Description: rank of the search result ,
Format: int32 ,
Required: False ,
}
integer ,
link:
{
Description: Link to the document. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
diagnostics:
{
Description: Solution diagnostics results. ,
Required: False ,
}
[
{
solutionId:
{
Description: Solution Id to identify single Solutions Diagnostic ,
Required: False ,
}
string ,
status:
{
Description: The status of the resource. ,
Enum:
{
Failed: No description available. ,
MissingInputs: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: Details of the status ,
Required: False ,
}
string ,
replacementKey:
{
Description: Place holder used in HTML Content replace control with the content ,
Required: False ,
}
string ,
requiredParameters:
{
Description: Required parameters of this item ,
Required: False ,
}
[
string ,
]
,
insights:
{
Description: Diagnostic insights ,
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 ,
}
,
]
,
}
,
]
,
troubleshooters:
{
Description: Solutions Troubleshooters ,
Required: False ,
}
[
{
solutionId:
{
Description: Solution Id to identify single Solutions Troubleshooter ,
Required: False ,
}
string ,
title:
{
Description: Troubleshooter title ,
Required: False ,
}
string ,
summary:
{
Description: Troubleshooter summary ,
Required: False ,
}
string ,
}
,
]
,
metricsBasedCharts:
{
Description: Solution metrics based charts ,
Required: False ,
}
[
{
name:
{
Description: Chart name ,
Required: False ,
}
string ,
aggregationType:
{
Description: Allowed values are Sum, Avg, Count, Min, Max. Default is Sum ,
Enum:
{
Sum: No description available. ,
Avg: No description available. ,
Count: No description available. ,
Min: No description available. ,
Max: No description available. ,
}
,
Required: False ,
}
enum ,
timeSpanDuration:
{
Description: Time span duration ,
Required: False ,
}
string ,
title:
{
Description: Chart title ,
Required: False ,
}
string ,
filterGroup:
{
Description: Filter group ,
Required: False ,
}
{
filter:
{
Description: List of filters ,
Required: False ,
}
[
{
name:
{
Description: Filter name ,
Required: False ,
}
string ,
values:
{
Description: Filter values ,
Required: False ,
}
string ,
operator:
{
Description: Filter operator ,
Required: False ,
}
string ,
}
,
]
,
}
,
replacementKey:
{
Description: Place holder used in HTML Content replace control with the content ,
Required: False ,
}
string ,
}
,
]
,
videos:
{
Description: Video solutions, which have the power to engage the customer by stimulating their senses ,
Required: False ,
}
[
{
replacementKey:
{
Description: Place holder used in HTML Content replace control with the insight content ,
Required: False ,
}
string ,
}
,
]
,
videoGroups:
{
Description: Group of Videos ,
Required: False ,
}
[
{
videos:
{
Description: List of videos will be shown to customers ,
Required: False ,
}
[
{
src:
{
Description: Link to the video ,
Required: False ,
}
string ,
title:
{
Description: Title of the video ,
Required: False ,
}
string ,
}
,
]
,
replacementKey:
{
Description: Place holder used in HTML Content replace control with the insight content ,
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 ,
}
,
]
,
}
,
}
Solution_Update (new)
Description :  Update the requiredInputs or additional information needed to execute the solution
Reference :  Link ¶

⚼ Request

PATCH:  /{scope}/providers/Microsoft.Help/solutions/{solutionResourceName}
{
scope:
{
Description: scope = resourceUri of affected resource.
For example: /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read ,
Required: True ,
}
string ,
solutionResourceName:
{
Description: Solution resource Name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
solutionPatchRequestBody:
{
Description: The required request body for updating a solution resource. ,
Required: False ,
}
{
properties:
{
Description: Solution result ,
Required: False ,
}
{
triggerCriteria:
{
Description: Solution request trigger criteria ,
Required: False ,
}
[
{
name:
{
Description: Trigger criterion name. ,
Enum:
{
SolutionId: No description available. ,
ProblemClassificationId: No description available. ,
ReplacementKey: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: Trigger criterion value. ,
Required: False ,
}
string ,
}
,
]
,
parameters:
{
Description: Client input parameters to run Solution ,
Required: False ,
}
object ,
solutionId:
{
Description: Solution Id to identify single solution. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Status of solution provisioning. ,
Enum:
{
Succeeded: All Solutions in the Batch succeeded. ,
PartialComplete: Some Solutions are still running or failed. ,
Failed: All Solutions failed to run. ,
Running: All Solutions are still running. ,
Canceled: When Solutions request gets canceled. ,
}
,
Required: False ,
}
enum ,
title:
{
Description: The title. ,
Required: False ,
}
string ,
content:
{
Description: The HTML content that needs to be rendered and shown to customer. ,
Required: False ,
}
string ,
replacementMaps:
{
Description: Solution replacement maps. ,
Required: False ,
}
{
webResults:
{
Description: Solution AzureKB results ,
Required: False ,
}
[
{
replacementKey:
{
Description: Place holder used in HTML Content replace control with the content ,
Required: False ,
}
string ,
searchResults:
{
Description: AzureKB search results ,
Required: False ,
}
[
{
solutionId:
{
Description: Unique id of the result. ,
Required: False ,
}
string ,
content:
{
Description: Content of the search result. ,
Required: False ,
}
string ,
title:
{
Description: Title of the search result. ,
Required: False ,
}
string ,
confidence:
{
Description: Confidence of the search result. ,
Enum:
{
Low: No description available. ,
Medium: No description available. ,
High: No description available. ,
}
,
Required: False ,
}
enum ,
source:
{
Description: Source of the search result. ,
Required: False ,
}
string ,
resultType:
{
Description: Result type of the search result. ,
Enum:
{
Community: No description available. ,
Documentation: No description available. ,
}
,
Required: False ,
}
enum ,
rank:
{
Description: rank of the search result ,
Format: int32 ,
Required: False ,
}
integer ,
link:
{
Description: Link to the document. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
diagnostics:
{
Description: Solution diagnostics results. ,
Required: False ,
}
[
{
solutionId:
{
Description: Solution Id to identify single Solutions Diagnostic ,
Required: False ,
}
string ,
status:
{
Description: The status of the resource. ,
Enum:
{
Failed: No description available. ,
MissingInputs: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: Details of the status ,
Required: False ,
}
string ,
replacementKey:
{
Description: Place holder used in HTML Content replace control with the content ,
Required: False ,
}
string ,
requiredParameters:
{
Description: Required parameters of this item ,
Required: False ,
}
[
string ,
]
,
insights:
{
Description: Diagnostic insights ,
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 ,
}
,
]
,
}
,
]
,
troubleshooters:
{
Description: Solutions Troubleshooters ,
Required: False ,
}
[
{
solutionId:
{
Description: Solution Id to identify single Solutions Troubleshooter ,
Required: False ,
}
string ,
title:
{
Description: Troubleshooter title ,
Required: False ,
}
string ,
summary:
{
Description: Troubleshooter summary ,
Required: False ,
}
string ,
}
,
]
,
metricsBasedCharts:
{
Description: Solution metrics based charts ,
Required: False ,
}
[
{
name:
{
Description: Chart name ,
Required: False ,
}
string ,
aggregationType:
{
Description: Allowed values are Sum, Avg, Count, Min, Max. Default is Sum ,
Enum:
{
Sum: No description available. ,
Avg: No description available. ,
Count: No description available. ,
Min: No description available. ,
Max: No description available. ,
}
,
Required: False ,
}
enum ,
timeSpanDuration:
{
Description: Time span duration ,
Required: False ,
}
string ,
title:
{
Description: Chart title ,
Required: False ,
}
string ,
filterGroup:
{
Description: Filter group ,
Required: False ,
}
{
filter:
{
Description: List of filters ,
Required: False ,
}
[
{
name:
{
Description: Filter name ,
Required: False ,
}
string ,
values:
{
Description: Filter values ,
Required: False ,
}
string ,
operator:
{
Description: Filter operator ,
Required: False ,
}
string ,
}
,
]
,
}
,
replacementKey:
{
Description: Place holder used in HTML Content replace control with the content ,
Required: False ,
}
string ,
}
,
]
,
videos:
{
Description: Video solutions, which have the power to engage the customer by stimulating their senses ,
Required: False ,
}
[
{
replacementKey:
{
Description: Place holder used in HTML Content replace control with the insight content ,
Required: False ,
}
string ,
}
,
]
,
videoGroups:
{
Description: Group of Videos ,
Required: False ,
}
[
{
videos:
{
Description: List of videos will be shown to customers ,
Required: False ,
}
[
{
src:
{
Description: Link to the video ,
Required: False ,
}
string ,
title:
{
Description: Title of the video ,
Required: False ,
}
string ,
}
,
]
,
replacementKey:
{
Description: Place holder used in HTML Content replace control with the insight content ,
Required: False ,
}
string ,
}
,
]
,
}
,
sections:
{
Description: List of section object. ,
Required: False ,
}
[
{
title:
{
Description: Solution sections title. ,
Required: False ,
}
string ,
content:
{
Description: Solution sections content. ,
Required: False ,
}
string ,
replacementMaps:
{
Description: Solution replacement maps. ,
Required: False ,
}
{
webResults:
{
Description: Solution AzureKB results ,
Required: False ,
}
[
{
replacementKey:
{
Description: Place holder used in HTML Content replace control with the content ,
Required: False ,
}
string ,
searchResults:
{
Description: AzureKB search results ,
Required: False ,
}
[
{
solutionId:
{
Description: Unique id of the result. ,
Required: False ,
}
string ,
content:
{
Description: Content of the search result. ,
Required: False ,
}
string ,
title:
{
Description: Title of the search result. ,
Required: False ,
}
string ,
confidence:
{
Description: Confidence of the search result. ,
Enum:
{
Low: No description available. ,
Medium: No description available. ,
High: No description available. ,
}
,
Required: False ,
}
enum ,
source:
{
Description: Source of the search result. ,
Required: False ,
}
string ,
resultType:
{
Description: Result type of the search result. ,
Enum:
{
Community: No description available. ,
Documentation: No description available. ,
}
,
Required: False ,
}
enum ,
rank:
{
Description: rank of the search result ,
Format: int32 ,
Required: False ,
}
integer ,
link:
{
Description: Link to the document. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
diagnostics:
{
Description: Solution diagnostics results. ,
Required: False ,
}
[
{
solutionId:
{
Description: Solution Id to identify single Solutions Diagnostic ,
Required: False ,
}
string ,
status:
{
Description: The status of the resource. ,
Enum:
{
Failed: No description available. ,
MissingInputs: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: Details of the status ,
Required: False ,
}
string ,
replacementKey:
{
Description: Place holder used in HTML Content replace control with the content ,
Required: False ,
}
string ,
requiredParameters:
{
Description: Required parameters of this item ,
Required: False ,
}
[
string ,
]
,
insights:
{
Description: Diagnostic insights ,
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 ,
}
,
]
,
}
,
]
,
troubleshooters:
{
Description: Solutions Troubleshooters ,
Required: False ,
}
[
{
solutionId:
{
Description: Solution Id to identify single Solutions Troubleshooter ,
Required: False ,
}
string ,
title:
{
Description: Troubleshooter title ,
Required: False ,
}
string ,
summary:
{
Description: Troubleshooter summary ,
Required: False ,
}
string ,
}
,
]
,
metricsBasedCharts:
{
Description: Solution metrics based charts ,
Required: False ,
}
[
{
name:
{
Description: Chart name ,
Required: False ,
}
string ,
aggregationType:
{
Description: Allowed values are Sum, Avg, Count, Min, Max. Default is Sum ,
Enum:
{
Sum: No description available. ,
Avg: No description available. ,
Count: No description available. ,
Min: No description available. ,
Max: No description available. ,
}
,
Required: False ,
}
enum ,
timeSpanDuration:
{
Description: Time span duration ,
Required: False ,
}
string ,
title:
{
Description: Chart title ,
Required: False ,
}
string ,
filterGroup:
{
Description: Filter group ,
Required: False ,
}
{
filter:
{
Description: List of filters ,
Required: False ,
}
[
{
name:
{
Description: Filter name ,
Required: False ,
}
string ,
values:
{
Description: Filter values ,
Required: False ,
}
string ,
operator:
{
Description: Filter operator ,
Required: False ,
}
string ,
}
,
]
,
}
,
replacementKey:
{
Description: Place holder used in HTML Content replace control with the content ,
Required: False ,
}
string ,
}
,
]
,
videos:
{
Description: Video solutions, which have the power to engage the customer by stimulating their senses ,
Required: False ,
}
[
{
replacementKey:
{
Description: Place holder used in HTML Content replace control with the insight content ,
Required: False ,
}
string ,
}
,
]
,
videoGroups:
{
Description: Group of Videos ,
Required: False ,
}
[
{
videos:
{
Description: List of videos will be shown to customers ,
Required: False ,
}
[
{
src:
{
Description: Link to the video ,
Required: False ,
}
string ,
title:
{
Description: Title of the video ,
Required: False ,
}
string ,
}
,
]
,
replacementKey:
{
Description: Place holder used in HTML Content replace control with the insight content ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
}
,
}
,
}

⚐ Response (202)

{
$headers:
{
location: string ,
}
,
$schema:
{
Description: Solution response. ,
}
{
properties:
{
Description: Solution result ,
Required: False ,
}
{
triggerCriteria:
{
Description: Solution request trigger criteria ,
Required: False ,
}
[
{
name:
{
Description: Trigger criterion name. ,
Enum:
{
SolutionId: No description available. ,
ProblemClassificationId: No description available. ,
ReplacementKey: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: Trigger criterion value. ,
Required: False ,
}
string ,
}
,
]
,
parameters:
{
Description: Client input parameters to run Solution ,
Required: False ,
}
object ,
solutionId:
{
Description: Solution Id to identify single solution. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Status of solution provisioning. ,
Enum:
{
Succeeded: All Solutions in the Batch succeeded. ,
PartialComplete: Some Solutions are still running or failed. ,
Failed: All Solutions failed to run. ,
Running: All Solutions are still running. ,
Canceled: When Solutions request gets canceled. ,
}
,
Required: False ,
}
enum ,
title:
{
Description: The title. ,
Required: False ,
}
string ,
content:
{
Description: The HTML content that needs to be rendered and shown to customer. ,
Required: False ,
}
string ,
replacementMaps:
{
Description: Solution replacement maps. ,
Required: False ,
}
{
webResults:
{
Description: Solution AzureKB results ,
Required: False ,
}
[
{
replacementKey:
{
Description: Place holder used in HTML Content replace control with the content ,
Required: False ,
}
string ,
searchResults:
{
Description: AzureKB search results ,
Required: False ,
}
[
{
solutionId:
{
Description: Unique id of the result. ,
Required: False ,
}
string ,
content:
{
Description: Content of the search result. ,
Required: False ,
}
string ,
title:
{
Description: Title of the search result. ,
Required: False ,
}
string ,
confidence:
{
Description: Confidence of the search result. ,
Enum:
{
Low: No description available. ,
Medium: No description available. ,
High: No description available. ,
}
,
Required: False ,
}
enum ,
source:
{
Description: Source of the search result. ,
Required: False ,
}
string ,
resultType:
{
Description: Result type of the search result. ,
Enum:
{
Community: No description available. ,
Documentation: No description available. ,
}
,
Required: False ,
}
enum ,
rank:
{
Description: rank of the search result ,
Format: int32 ,
Required: False ,
}
integer ,
link:
{
Description: Link to the document. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
diagnostics:
{
Description: Solution diagnostics results. ,
Required: False ,
}
[
{
solutionId:
{
Description: Solution Id to identify single Solutions Diagnostic ,
Required: False ,
}
string ,
status:
{
Description: The status of the resource. ,
Enum:
{
Failed: No description available. ,
MissingInputs: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: Details of the status ,
Required: False ,
}
string ,
replacementKey:
{
Description: Place holder used in HTML Content replace control with the content ,
Required: False ,
}
string ,
requiredParameters:
{
Description: Required parameters of this item ,
Required: False ,
}
[
string ,
]
,
insights:
{
Description: Diagnostic insights ,
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 ,
}
,
]
,
}
,
]
,
troubleshooters:
{
Description: Solutions Troubleshooters ,
Required: False ,
}
[
{
solutionId:
{
Description: Solution Id to identify single Solutions Troubleshooter ,
Required: False ,
}
string ,
title:
{
Description: Troubleshooter title ,
Required: False ,
}
string ,
summary:
{
Description: Troubleshooter summary ,
Required: False ,
}
string ,
}
,
]
,
metricsBasedCharts:
{
Description: Solution metrics based charts ,
Required: False ,
}
[
{
name:
{
Description: Chart name ,
Required: False ,
}
string ,
aggregationType:
{
Description: Allowed values are Sum, Avg, Count, Min, Max. Default is Sum ,
Enum:
{
Sum: No description available. ,
Avg: No description available. ,
Count: No description available. ,
Min: No description available. ,
Max: No description available. ,
}
,
Required: False ,
}
enum ,
timeSpanDuration:
{
Description: Time span duration ,
Required: False ,
}
string ,
title:
{
Description: Chart title ,
Required: False ,
}
string ,
filterGroup:
{
Description: Filter group ,
Required: False ,
}
{
filter:
{
Description: List of filters ,
Required: False ,
}
[
{
name:
{
Description: Filter name ,
Required: False ,
}
string ,
values:
{
Description: Filter values ,
Required: False ,
}
string ,
operator:
{
Description: Filter operator ,
Required: False ,
}
string ,
}
,
]
,
}
,
replacementKey:
{
Description: Place holder used in HTML Content replace control with the content ,
Required: False ,
}
string ,
}
,
]
,
videos:
{
Description: Video solutions, which have the power to engage the customer by stimulating their senses ,
Required: False ,
}
[
{
replacementKey:
{
Description: Place holder used in HTML Content replace control with the insight content ,
Required: False ,
}
string ,
}
,
]
,
videoGroups:
{
Description: Group of Videos ,
Required: False ,
}
[
{
videos:
{
Description: List of videos will be shown to customers ,
Required: False ,
}
[
{
src:
{
Description: Link to the video ,
Required: False ,
}
string ,
title:
{
Description: Title of the video ,
Required: False ,
}
string ,
}
,
]
,
replacementKey:
{
Description: Place holder used in HTML Content replace control with the insight content ,
Required: False ,
}
string ,
}
,
]
,
}
,
sections:
{
Description: List of section object. ,
Required: False ,
}
[
{
title:
{
Description: Solution sections title. ,
Required: False ,
}
string ,
content:
{
Description: Solution sections content. ,
Required: False ,
}
string ,
replacementMaps:
{
Description: Solution replacement maps. ,
Required: False ,
}
{
webResults:
{
Description: Solution AzureKB results ,
Required: False ,
}
[
{
replacementKey:
{
Description: Place holder used in HTML Content replace control with the content ,
Required: False ,
}
string ,
searchResults:
{
Description: AzureKB search results ,
Required: False ,
}
[
{
solutionId:
{
Description: Unique id of the result. ,
Required: False ,
}
string ,
content:
{
Description: Content of the search result. ,
Required: False ,
}
string ,
title:
{
Description: Title of the search result. ,
Required: False ,
}
string ,
confidence:
{
Description: Confidence of the search result. ,
Enum:
{
Low: No description available. ,
Medium: No description available. ,
High: No description available. ,
}
,
Required: False ,
}
enum ,
source:
{
Description: Source of the search result. ,
Required: False ,
}
string ,
resultType:
{
Description: Result type of the search result. ,
Enum:
{
Community: No description available. ,
Documentation: No description available. ,
}
,
Required: False ,
}
enum ,
rank:
{
Description: rank of the search result ,
Format: int32 ,
Required: False ,
}
integer ,
link:
{
Description: Link to the document. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
diagnostics:
{
Description: Solution diagnostics results. ,
Required: False ,
}
[
{
solutionId:
{
Description: Solution Id to identify single Solutions Diagnostic ,
Required: False ,
}
string ,
status:
{
Description: The status of the resource. ,
Enum:
{
Failed: No description available. ,
MissingInputs: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: Details of the status ,
Required: False ,
}
string ,
replacementKey:
{
Description: Place holder used in HTML Content replace control with the content ,
Required: False ,
}
string ,
requiredParameters:
{
Description: Required parameters of this item ,
Required: False ,
}
[
string ,
]
,
insights:
{
Description: Diagnostic insights ,
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 ,
}
,
]
,
}
,
]
,
troubleshooters:
{
Description: Solutions Troubleshooters ,
Required: False ,
}
[
{
solutionId:
{
Description: Solution Id to identify single Solutions Troubleshooter ,
Required: False ,
}
string ,
title:
{
Description: Troubleshooter title ,
Required: False ,
}
string ,
summary:
{
Description: Troubleshooter summary ,
Required: False ,
}
string ,
}
,
]
,
metricsBasedCharts:
{
Description: Solution metrics based charts ,
Required: False ,
}
[
{
name:
{
Description: Chart name ,
Required: False ,
}
string ,
aggregationType:
{
Description: Allowed values are Sum, Avg, Count, Min, Max. Default is Sum ,
Enum:
{
Sum: No description available. ,
Avg: No description available. ,
Count: No description available. ,
Min: No description available. ,
Max: No description available. ,
}
,
Required: False ,
}
enum ,
timeSpanDuration:
{
Description: Time span duration ,
Required: False ,
}
string ,
title:
{
Description: Chart title ,
Required: False ,
}
string ,
filterGroup:
{
Description: Filter group ,
Required: False ,
}
{
filter:
{
Description: List of filters ,
Required: False ,
}
[
{
name:
{
Description: Filter name ,
Required: False ,
}
string ,
values:
{
Description: Filter values ,
Required: False ,
}
string ,
operator:
{
Description: Filter operator ,
Required: False ,
}
string ,
}
,
]
,
}
,
replacementKey:
{
Description: Place holder used in HTML Content replace control with the content ,
Required: False ,
}
string ,
}
,
]
,
videos:
{
Description: Video solutions, which have the power to engage the customer by stimulating their senses ,
Required: False ,
}
[
{
replacementKey:
{
Description: Place holder used in HTML Content replace control with the insight content ,
Required: False ,
}
string ,
}
,
]
,
videoGroups:
{
Description: Group of Videos ,
Required: False ,
}
[
{
videos:
{
Description: List of videos will be shown to customers ,
Required: False ,
}
[
{
src:
{
Description: Link to the video ,
Required: False ,
}
string ,
title:
{
Description: Title of the video ,
Required: False ,
}
string ,
}
,
]
,
replacementKey:
{
Description: Place holder used in HTML Content replace control with the insight content ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
$headers:
{
location: string ,
}
,
$schema:
{
Description: Solution response. ,
}
{
properties:
{
Description: Solution result ,
Required: False ,
}
{
triggerCriteria:
{
Description: Solution request trigger criteria ,
Required: False ,
}
[
{
name:
{
Description: Trigger criterion name. ,
Enum:
{
SolutionId: No description available. ,
ProblemClassificationId: No description available. ,
ReplacementKey: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: Trigger criterion value. ,
Required: False ,
}
string ,
}
,
]
,
parameters:
{
Description: Client input parameters to run Solution ,
Required: False ,
}
object ,
solutionId:
{
Description: Solution Id to identify single solution. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Status of solution provisioning. ,
Enum:
{
Succeeded: All Solutions in the Batch succeeded. ,
PartialComplete: Some Solutions are still running or failed. ,
Failed: All Solutions failed to run. ,
Running: All Solutions are still running. ,
Canceled: When Solutions request gets canceled. ,
}
,
Required: False ,
}
enum ,
title:
{
Description: The title. ,
Required: False ,
}
string ,
content:
{
Description: The HTML content that needs to be rendered and shown to customer. ,
Required: False ,
}
string ,
replacementMaps:
{
Description: Solution replacement maps. ,
Required: False ,
}
{
webResults:
{
Description: Solution AzureKB results ,
Required: False ,
}
[
{
replacementKey:
{
Description: Place holder used in HTML Content replace control with the content ,
Required: False ,
}
string ,
searchResults:
{
Description: AzureKB search results ,
Required: False ,
}
[
{
solutionId:
{
Description: Unique id of the result. ,
Required: False ,
}
string ,
content:
{
Description: Content of the search result. ,
Required: False ,
}
string ,
title:
{
Description: Title of the search result. ,
Required: False ,
}
string ,
confidence:
{
Description: Confidence of the search result. ,
Enum:
{
Low: No description available. ,
Medium: No description available. ,
High: No description available. ,
}
,
Required: False ,
}
enum ,
source:
{
Description: Source of the search result. ,
Required: False ,
}
string ,
resultType:
{
Description: Result type of the search result. ,
Enum:
{
Community: No description available. ,
Documentation: No description available. ,
}
,
Required: False ,
}
enum ,
rank:
{
Description: rank of the search result ,
Format: int32 ,
Required: False ,
}
integer ,
link:
{
Description: Link to the document. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
diagnostics:
{
Description: Solution diagnostics results. ,
Required: False ,
}
[
{
solutionId:
{
Description: Solution Id to identify single Solutions Diagnostic ,
Required: False ,
}
string ,
status:
{
Description: The status of the resource. ,
Enum:
{
Failed: No description available. ,
MissingInputs: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: Details of the status ,
Required: False ,
}
string ,
replacementKey:
{
Description: Place holder used in HTML Content replace control with the content ,
Required: False ,
}
string ,
requiredParameters:
{
Description: Required parameters of this item ,
Required: False ,
}
[
string ,
]
,
insights:
{
Description: Diagnostic insights ,
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 ,
}
,
]
,
}
,
]
,
troubleshooters:
{
Description: Solutions Troubleshooters ,
Required: False ,
}
[
{
solutionId:
{
Description: Solution Id to identify single Solutions Troubleshooter ,
Required: False ,
}
string ,
title:
{
Description: Troubleshooter title ,
Required: False ,
}
string ,
summary:
{
Description: Troubleshooter summary ,
Required: False ,
}
string ,
}
,
]
,
metricsBasedCharts:
{
Description: Solution metrics based charts ,
Required: False ,
}
[
{
name:
{
Description: Chart name ,
Required: False ,
}
string ,
aggregationType:
{
Description: Allowed values are Sum, Avg, Count, Min, Max. Default is Sum ,
Enum:
{
Sum: No description available. ,
Avg: No description available. ,
Count: No description available. ,
Min: No description available. ,
Max: No description available. ,
}
,
Required: False ,
}
enum ,
timeSpanDuration:
{
Description: Time span duration ,
Required: False ,
}
string ,
title:
{
Description: Chart title ,
Required: False ,
}
string ,
filterGroup:
{
Description: Filter group ,
Required: False ,
}
{
filter:
{
Description: List of filters ,
Required: False ,
}
[
{
name:
{
Description: Filter name ,
Required: False ,
}
string ,
values:
{
Description: Filter values ,
Required: False ,
}
string ,
operator:
{
Description: Filter operator ,
Required: False ,
}
string ,
}
,
]
,
}
,
replacementKey:
{
Description: Place holder used in HTML Content replace control with the content ,
Required: False ,
}
string ,
}
,
]
,
videos:
{
Description: Video solutions, which have the power to engage the customer by stimulating their senses ,
Required: False ,
}
[
{
replacementKey:
{
Description: Place holder used in HTML Content replace control with the insight content ,
Required: False ,
}
string ,
}
,
]
,
videoGroups:
{
Description: Group of Videos ,
Required: False ,
}
[
{
videos:
{
Description: List of videos will be shown to customers ,
Required: False ,
}
[
{
src:
{
Description: Link to the video ,
Required: False ,
}
string ,
title:
{
Description: Title of the video ,
Required: False ,
}
string ,
}
,
]
,
replacementKey:
{
Description: Place holder used in HTML Content replace control with the insight content ,
Required: False ,
}
string ,
}
,
]
,
}
,
sections:
{
Description: List of section object. ,
Required: False ,
}
[
{
title:
{
Description: Solution sections title. ,
Required: False ,
}
string ,
content:
{
Description: Solution sections content. ,
Required: False ,
}
string ,
replacementMaps:
{
Description: Solution replacement maps. ,
Required: False ,
}
{
webResults:
{
Description: Solution AzureKB results ,
Required: False ,
}
[
{
replacementKey:
{
Description: Place holder used in HTML Content replace control with the content ,
Required: False ,
}
string ,
searchResults:
{
Description: AzureKB search results ,
Required: False ,
}
[
{
solutionId:
{
Description: Unique id of the result. ,
Required: False ,
}
string ,
content:
{
Description: Content of the search result. ,
Required: False ,
}
string ,
title:
{
Description: Title of the search result. ,
Required: False ,
}
string ,
confidence:
{
Description: Confidence of the search result. ,
Enum:
{
Low: No description available. ,
Medium: No description available. ,
High: No description available. ,
}
,
Required: False ,
}
enum ,
source:
{
Description: Source of the search result. ,
Required: False ,
}
string ,
resultType:
{
Description: Result type of the search result. ,
Enum:
{
Community: No description available. ,
Documentation: No description available. ,
}
,
Required: False ,
}
enum ,
rank:
{
Description: rank of the search result ,
Format: int32 ,
Required: False ,
}
integer ,
link:
{
Description: Link to the document. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
diagnostics:
{
Description: Solution diagnostics results. ,
Required: False ,
}
[
{
solutionId:
{
Description: Solution Id to identify single Solutions Diagnostic ,
Required: False ,
}
string ,
status:
{
Description: The status of the resource. ,
Enum:
{
Failed: No description available. ,
MissingInputs: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: Details of the status ,
Required: False ,
}
string ,
replacementKey:
{
Description: Place holder used in HTML Content replace control with the content ,
Required: False ,
}
string ,
requiredParameters:
{
Description: Required parameters of this item ,
Required: False ,
}
[
string ,
]
,
insights:
{
Description: Diagnostic insights ,
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 ,
}
,
]
,
}
,
]
,
troubleshooters:
{
Description: Solutions Troubleshooters ,
Required: False ,
}
[
{
solutionId:
{
Description: Solution Id to identify single Solutions Troubleshooter ,
Required: False ,
}
string ,
title:
{
Description: Troubleshooter title ,
Required: False ,
}
string ,
summary:
{
Description: Troubleshooter summary ,
Required: False ,
}
string ,
}
,
]
,
metricsBasedCharts:
{
Description: Solution metrics based charts ,
Required: False ,
}
[
{
name:
{
Description: Chart name ,
Required: False ,
}
string ,
aggregationType:
{
Description: Allowed values are Sum, Avg, Count, Min, Max. Default is Sum ,
Enum:
{
Sum: No description available. ,
Avg: No description available. ,
Count: No description available. ,
Min: No description available. ,
Max: No description available. ,
}
,
Required: False ,
}
enum ,
timeSpanDuration:
{
Description: Time span duration ,
Required: False ,
}
string ,
title:
{
Description: Chart title ,
Required: False ,
}
string ,
filterGroup:
{
Description: Filter group ,
Required: False ,
}
{
filter:
{
Description: List of filters ,
Required: False ,
}
[
{
name:
{
Description: Filter name ,
Required: False ,
}
string ,
values:
{
Description: Filter values ,
Required: False ,
}
string ,
operator:
{
Description: Filter operator ,
Required: False ,
}
string ,
}
,
]
,
}
,
replacementKey:
{
Description: Place holder used in HTML Content replace control with the content ,
Required: False ,
}
string ,
}
,
]
,
videos:
{
Description: Video solutions, which have the power to engage the customer by stimulating their senses ,
Required: False ,
}
[
{
replacementKey:
{
Description: Place holder used in HTML Content replace control with the insight content ,
Required: False ,
}
string ,
}
,
]
,
videoGroups:
{
Description: Group of Videos ,
Required: False ,
}
[
{
videos:
{
Description: List of videos will be shown to customers ,
Required: False ,
}
[
{
src:
{
Description: Link to the video ,
Required: False ,
}
string ,
title:
{
Description: Title of the video ,
Required: False ,
}
string ,
}
,
]
,
replacementKey:
{
Description: Place holder used in HTML Content replace control with the insight content ,
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 ,
}
,
]
,
}
,
}
Troubleshooters_Create (new)
Description :  Creates the specific troubleshooter action under a resource or subscription using the ‘solutionId’ and ‘properties.parameters’ as the trigger.
Azure Troubleshooters help with hard to classify issues, reducing the gap between customer observed problems and solutions by guiding the user effortlessly through the troubleshooting process. Each Troubleshooter flow represents a problem area within Azure and has a complex tree-like structure that addresses many root causes. These flows are prepared with the help of Subject Matter experts and customer support engineers by carefully considering previous support requests raised by customers. Troubleshooters terminate at a well curated solution based off of resource backend signals and customer manual selections.
Reference :  Link ¶

⚼ Request

PUT:  /{scope}/providers/Microsoft.Help/troubleshooters/{troubleshooterName}
{
scope:
{
Description: scope = resourceUri of affected resource.
For example: /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read ,
Required: True ,
}
string ,
troubleshooterName:
{
Description: Troubleshooter resource Name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
createTroubleshooterRequestBody:
{
Description: The required request body for this Troubleshooter resource creation. ,
Required: False ,
}
{
properties:
{
Description: Troubleshooter Instance properties. ,
Required: False ,
}
{
solutionId:
{
Description: Solution Id to identify single troubleshooter. ,
Required: False ,
}
string ,
parameters:
{
Description: Client input parameters to run Troubleshooter Resource ,
Required: False ,
}
object ,
provisioningState:
{
Description: Status of troubleshooter provisioning. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Running: No description available. ,
AutoContinue: No description available. ,
}
,
Required: False ,
}
enum ,
steps:
{
Description: List of step object. ,
Required: False ,
}
[
{
id:
{
Description: Unique step id. ,
Required: False ,
}
string ,
title:
{
Description: Step title. ,
Required: False ,
}
string ,
description:
{
Description: Step description. ,
Required: False ,
}
string ,
guidance:
{
Description: Get or sets the Step guidance. ,
Required: False ,
}
string ,
executionStatus:
{
Description: Status of Troubleshooter Step execution. ,
Enum:
{
Success: Step execution succeeded. ,
Running: Step execution running ,
Failed: Step execution failed ,
Warning: Step execution warning ,
}
,
Required: False ,
}
enum ,
executionStatusDescription:
{
Description: This field has more detailed status description of the execution status. ,
Required: False ,
}
string ,
type:
{
Description: Type of Troubleshooting step. ,
Enum:
{
Decision: No description available. ,
Solution: No description available. ,
Insight: No description available. ,
AutomatedCheck: No description available. ,
}
,
Required: False ,
}
enum ,
isLastStep:
{
Description: is this last step of the workflow. ,
Required: False ,
}
boolean ,
inputs:
{
Required: False ,
}
[
{
questionId:
{
Description: Use Index as QuestionId. ,
Required: False ,
}
string ,
questionType:
{
Description: Type of Question ,
Enum:
{
RadioButton: SingleChoice radio button ,
Dropdown: SingleChoice dropdown. ,
TextInput: Text Input ,
MultiLineInfoBox: MultiLineInfoBox ,
}
,
Required: False ,
}
enum ,
questionContent:
{
Description: User question content. ,
Required: False ,
}
string ,
questionContentType:
{
Description: Default is Text. ,
Enum:
{
Text: No description available. ,
Html: No description available. ,
Markdown: No description available. ,
}
,
Required: False ,
}
enum ,
responseHint:
{
Description: Place holder text for response hints. ,
Required: False ,
}
string ,
recommendedOption:
{
Description: Result of Automate step. ,
Required: False ,
}
string ,
selectedOptionValue:
{
Description: Text of response that was selected. ,
Required: False ,
}
string ,
responseValidationProperties:
{
Description: Troubleshooter step input response validation properties ,
Required: False ,
}
{
regex:
{
Description: Regex used for the input validation. ,
Required: False ,
}
string ,
isRequired:
{
Description: Default True ,
Required: False ,
}
boolean ,
validationErrorMessage:
{
Description: Validation Error Message. ,
Required: False ,
}
string ,
maxLength:
{
Description: Max text input (open Ended Text). ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
responseOptions:
{
Required: False ,
}
[
{
key:
{
Description: Unique string. ,
Required: False ,
}
string ,
value:
{
Description: Option description ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
automatedCheckResults:
{
Description: Only for AutomatedStep type ,
Required: False ,
}
{
result:
{
Description: Insight Article Content ,
Required: False ,
}
string ,
type:
{
Description: Type of Result. ,
Enum:
{
Success: No description available. ,
Warning: No description available. ,
Error: No description available. ,
Information: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
insights:
{
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: The error detail. ,
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 ,
}
,
]
,
}
,
}
,
]
,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Troubleshooter Instance properties. ,
Required: False ,
}
{
solutionId:
{
Description: Solution Id to identify single troubleshooter. ,
Required: False ,
}
string ,
parameters:
{
Description: Client input parameters to run Troubleshooter Resource ,
Required: False ,
}
object ,
provisioningState:
{
Description: Status of troubleshooter provisioning. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Running: No description available. ,
AutoContinue: No description available. ,
}
,
Required: False ,
}
enum ,
steps:
{
Description: List of step object. ,
Required: False ,
}
[
{
id:
{
Description: Unique step id. ,
Required: False ,
}
string ,
title:
{
Description: Step title. ,
Required: False ,
}
string ,
description:
{
Description: Step description. ,
Required: False ,
}
string ,
guidance:
{
Description: Get or sets the Step guidance. ,
Required: False ,
}
string ,
executionStatus:
{
Description: Status of Troubleshooter Step execution. ,
Enum:
{
Success: Step execution succeeded. ,
Running: Step execution running ,
Failed: Step execution failed ,
Warning: Step execution warning ,
}
,
Required: False ,
}
enum ,
executionStatusDescription:
{
Description: This field has more detailed status description of the execution status. ,
Required: False ,
}
string ,
type:
{
Description: Type of Troubleshooting step. ,
Enum:
{
Decision: No description available. ,
Solution: No description available. ,
Insight: No description available. ,
AutomatedCheck: No description available. ,
}
,
Required: False ,
}
enum ,
isLastStep:
{
Description: is this last step of the workflow. ,
Required: False ,
}
boolean ,
inputs:
{
Required: False ,
}
[
{
questionId:
{
Description: Use Index as QuestionId. ,
Required: False ,
}
string ,
questionType:
{
Description: Type of Question ,
Enum:
{
RadioButton: SingleChoice radio button ,
Dropdown: SingleChoice dropdown. ,
TextInput: Text Input ,
MultiLineInfoBox: MultiLineInfoBox ,
}
,
Required: False ,
}
enum ,
questionContent:
{
Description: User question content. ,
Required: False ,
}
string ,
questionContentType:
{
Description: Default is Text. ,
Enum:
{
Text: No description available. ,
Html: No description available. ,
Markdown: No description available. ,
}
,
Required: False ,
}
enum ,
responseHint:
{
Description: Place holder text for response hints. ,
Required: False ,
}
string ,
recommendedOption:
{
Description: Result of Automate step. ,
Required: False ,
}
string ,
selectedOptionValue:
{
Description: Text of response that was selected. ,
Required: False ,
}
string ,
responseValidationProperties:
{
Description: Troubleshooter step input response validation properties ,
Required: False ,
}
{
regex:
{
Description: Regex used for the input validation. ,
Required: False ,
}
string ,
isRequired:
{
Description: Default True ,
Required: False ,
}
boolean ,
validationErrorMessage:
{
Description: Validation Error Message. ,
Required: False ,
}
string ,
maxLength:
{
Description: Max text input (open Ended Text). ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
responseOptions:
{
Required: False ,
}
[
{
key:
{
Description: Unique string. ,
Required: False ,
}
string ,
value:
{
Description: Option description ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
automatedCheckResults:
{
Description: Only for AutomatedStep type ,
Required: False ,
}
{
result:
{
Description: Insight Article Content ,
Required: False ,
}
string ,
type:
{
Description: Type of Result. ,
Enum:
{
Success: No description available. ,
Warning: No description available. ,
Error: No description available. ,
Information: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
insights:
{
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: The error detail. ,
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 ,
}
,
]
,
}
,
}
,
]
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Troubleshooter Instance properties. ,
Required: False ,
}
{
solutionId:
{
Description: Solution Id to identify single troubleshooter. ,
Required: False ,
}
string ,
parameters:
{
Description: Client input parameters to run Troubleshooter Resource ,
Required: False ,
}
object ,
provisioningState:
{
Description: Status of troubleshooter provisioning. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Running: No description available. ,
AutoContinue: No description available. ,
}
,
Required: False ,
}
enum ,
steps:
{
Description: List of step object. ,
Required: False ,
}
[
{
id:
{
Description: Unique step id. ,
Required: False ,
}
string ,
title:
{
Description: Step title. ,
Required: False ,
}
string ,
description:
{
Description: Step description. ,
Required: False ,
}
string ,
guidance:
{
Description: Get or sets the Step guidance. ,
Required: False ,
}
string ,
executionStatus:
{
Description: Status of Troubleshooter Step execution. ,
Enum:
{
Success: Step execution succeeded. ,
Running: Step execution running ,
Failed: Step execution failed ,
Warning: Step execution warning ,
}
,
Required: False ,
}
enum ,
executionStatusDescription:
{
Description: This field has more detailed status description of the execution status. ,
Required: False ,
}
string ,
type:
{
Description: Type of Troubleshooting step. ,
Enum:
{
Decision: No description available. ,
Solution: No description available. ,
Insight: No description available. ,
AutomatedCheck: No description available. ,
}
,
Required: False ,
}
enum ,
isLastStep:
{
Description: is this last step of the workflow. ,
Required: False ,
}
boolean ,
inputs:
{
Required: False ,
}
[
{
questionId:
{
Description: Use Index as QuestionId. ,
Required: False ,
}
string ,
questionType:
{
Description: Type of Question ,
Enum:
{
RadioButton: SingleChoice radio button ,
Dropdown: SingleChoice dropdown. ,
TextInput: Text Input ,
MultiLineInfoBox: MultiLineInfoBox ,
}
,
Required: False ,
}
enum ,
questionContent:
{
Description: User question content. ,
Required: False ,
}
string ,
questionContentType:
{
Description: Default is Text. ,
Enum:
{
Text: No description available. ,
Html: No description available. ,
Markdown: No description available. ,
}
,
Required: False ,
}
enum ,
responseHint:
{
Description: Place holder text for response hints. ,
Required: False ,
}
string ,
recommendedOption:
{
Description: Result of Automate step. ,
Required: False ,
}
string ,
selectedOptionValue:
{
Description: Text of response that was selected. ,
Required: False ,
}
string ,
responseValidationProperties:
{
Description: Troubleshooter step input response validation properties ,
Required: False ,
}
{
regex:
{
Description: Regex used for the input validation. ,
Required: False ,
}
string ,
isRequired:
{
Description: Default True ,
Required: False ,
}
boolean ,
validationErrorMessage:
{
Description: Validation Error Message. ,
Required: False ,
}
string ,
maxLength:
{
Description: Max text input (open Ended Text). ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
responseOptions:
{
Required: False ,
}
[
{
key:
{
Description: Unique string. ,
Required: False ,
}
string ,
value:
{
Description: Option description ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
automatedCheckResults:
{
Description: Only for AutomatedStep type ,
Required: False ,
}
{
result:
{
Description: Insight Article Content ,
Required: False ,
}
string ,
type:
{
Description: Type of Result. ,
Enum:
{
Success: No description available. ,
Warning: No description available. ,
Error: No description available. ,
Information: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
insights:
{
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: The error detail. ,
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 ,
}
,
]
,
}
,
}
,
]
,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
Troubleshooters_Get (new)
Description :  Gets troubleshooter instance result which includes the step status/result of the troubleshooter resource name that is being executed.
Get API is used to retrieve the result of a Troubleshooter instance, which includes the status and result of each step in the Troubleshooter workflow. This API requires the Troubleshooter resource name that was created using the Create API.
Reference :  Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.Help/troubleshooters/{troubleshooterName}
{
scope:
{
Description: scope = resourceUri of affected resource.
For example: /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read ,
Required: True ,
}
string ,
troubleshooterName:
{
Description: Troubleshooter resource Name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Troubleshooter Instance properties. ,
Required: False ,
}
{
solutionId:
{
Description: Solution Id to identify single troubleshooter. ,
Required: False ,
}
string ,
parameters:
{
Description: Client input parameters to run Troubleshooter Resource ,
Required: False ,
}
object ,
provisioningState:
{
Description: Status of troubleshooter provisioning. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Running: No description available. ,
AutoContinue: No description available. ,
}
,
Required: False ,
}
enum ,
steps:
{
Description: List of step object. ,
Required: False ,
}
[
{
id:
{
Description: Unique step id. ,
Required: False ,
}
string ,
title:
{
Description: Step title. ,
Required: False ,
}
string ,
description:
{
Description: Step description. ,
Required: False ,
}
string ,
guidance:
{
Description: Get or sets the Step guidance. ,
Required: False ,
}
string ,
executionStatus:
{
Description: Status of Troubleshooter Step execution. ,
Enum:
{
Success: Step execution succeeded. ,
Running: Step execution running ,
Failed: Step execution failed ,
Warning: Step execution warning ,
}
,
Required: False ,
}
enum ,
executionStatusDescription:
{
Description: This field has more detailed status description of the execution status. ,
Required: False ,
}
string ,
type:
{
Description: Type of Troubleshooting step. ,
Enum:
{
Decision: No description available. ,
Solution: No description available. ,
Insight: No description available. ,
AutomatedCheck: No description available. ,
}
,
Required: False ,
}
enum ,
isLastStep:
{
Description: is this last step of the workflow. ,
Required: False ,
}
boolean ,
inputs:
{
Required: False ,
}
[
{
questionId:
{
Description: Use Index as QuestionId. ,
Required: False ,
}
string ,
questionType:
{
Description: Type of Question ,
Enum:
{
RadioButton: SingleChoice radio button ,
Dropdown: SingleChoice dropdown. ,
TextInput: Text Input ,
MultiLineInfoBox: MultiLineInfoBox ,
}
,
Required: False ,
}
enum ,
questionContent:
{
Description: User question content. ,
Required: False ,
}
string ,
questionContentType:
{
Description: Default is Text. ,
Enum:
{
Text: No description available. ,
Html: No description available. ,
Markdown: No description available. ,
}
,
Required: False ,
}
enum ,
responseHint:
{
Description: Place holder text for response hints. ,
Required: False ,
}
string ,
recommendedOption:
{
Description: Result of Automate step. ,
Required: False ,
}
string ,
selectedOptionValue:
{
Description: Text of response that was selected. ,
Required: False ,
}
string ,
responseValidationProperties:
{
Description: Troubleshooter step input response validation properties ,
Required: False ,
}
{
regex:
{
Description: Regex used for the input validation. ,
Required: False ,
}
string ,
isRequired:
{
Description: Default True ,
Required: False ,
}
boolean ,
validationErrorMessage:
{
Description: Validation Error Message. ,
Required: False ,
}
string ,
maxLength:
{
Description: Max text input (open Ended Text). ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
responseOptions:
{
Required: False ,
}
[
{
key:
{
Description: Unique string. ,
Required: False ,
}
string ,
value:
{
Description: Option description ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
automatedCheckResults:
{
Description: Only for AutomatedStep type ,
Required: False ,
}
{
result:
{
Description: Insight Article Content ,
Required: False ,
}
string ,
type:
{
Description: Type of Result. ,
Enum:
{
Success: No description available. ,
Warning: No description available. ,
Error: No description available. ,
Information: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
insights:
{
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: The error detail. ,
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 ,
}
,
]
,
}
,
}
,
]
,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
Troubleshooters_Continue (new)
Description :  Uses ‘stepId’ and ‘responses’ as the trigger to continue the troubleshooting steps for the respective troubleshooter resource name.
Continue API is used to provide inputs that are required for the specific troubleshooter to progress into the next step in the process. This API is used after the Troubleshooter has been created using the Create API.
Reference :  Link ¶

⚼ Request

POST:  /{scope}/providers/Microsoft.Help/troubleshooters/{troubleshooterName}/continue
{
scope:
{
Description: scope = resourceUri of affected resource.
For example: /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read ,
Required: True ,
}
string ,
troubleshooterName:
{
Description: Troubleshooter resource Name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
continueRequestBody:
{
Description: The required request body for going to next step in Troubleshooter resource. ,
Required: False ,
}
{
stepId:
{
Description: Unique id of the result. ,
Required: False ,
}
string ,
responses:
{
Required: False ,
}
[
{
questionId:
{
Description: id of the question. ,
Required: False ,
}
string ,
questionType:
{
Description: Type of Question ,
Enum:
{
RadioButton: SingleChoice radio button ,
Dropdown: SingleChoice dropdown. ,
TextInput: Text Input ,
MultiLineInfoBox: MultiLineInfoBox ,
}
,
Required: False ,
}
enum ,
response:
{
Description: Response key for SingleInput. For Multi-line test/open ended question it is free form text ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (204)

{
location: 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 ,
}
,
]
,
}
,
}
Troubleshooters_End (new)
Description :  Ends the troubleshooter action
Reference :  Link ¶

⚼ Request

POST:  /{scope}/providers/Microsoft.Help/troubleshooters/{troubleshooterName}/end
{
scope:
{
Description: scope = resourceUri of affected resource.
For example: /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read ,
Required: True ,
}
string ,
troubleshooterName:
{
Description: Troubleshooter resource Name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{
location: 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 ,
}
,
]
,
}
,
}
Troubleshooters_Restart (new)
Description :  Restarts the troubleshooter API using applicable troubleshooter resource name as the input.
It returns new resource name which should be used in subsequent request. The old resource name is obsolete after this API is invoked.
Reference :  Link ¶

⚼ Request

POST:  /{scope}/providers/Microsoft.Help/troubleshooters/{troubleshooterName}/restart
{
scope:
{
Description: scope = resourceUri of affected resource.
For example: /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read ,
Required: True ,
}
string ,
troubleshooterName:
{
Description: Troubleshooter resource Name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
location: string ,
}
,
$schema:
{
Description: Troubleshooter restart response ,
}
{
troubleshooterResourceName:
{
Description: Updated TroubleshooterResource Name . ,
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). ,
Format: uri ,
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 ,
}
,
]
,
}
,
}
CheckNameAvailability_Post (removed)
Description :  This API is used to check the uniqueness of a resource name used for a diagnostic, troubleshooter or solutions
Reference :  Link ¶

⚼ Request

POST:  /{scope}/providers/Microsoft.Help/checkNameAvailability
{
scope:
{
Description: scope = resourceUri of affected resource.
For example: /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read ,
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 :  Creates a diagnostic for the specific resource using solutionId and requiredInputs* from discovery solutions.
Diagnostics are powerful solutions that access product resources or other relevant data and provide the root cause of the issue and the steps to address the issue.

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

⚼ Request

PUT:  /{scope}/providers/Microsoft.Help/diagnostics/{diagnosticsResourceName}
{
scope:
{
Description: scope = resourceUri of affected resource.
For example: /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read ,
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 is an optional map which can be used to add key and value to request body to improve the diagnostics results ,
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. ,
Running: All Diagnostics are still running. ,
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 is an optional map which can be used to add key and value to request body to improve the diagnostics results ,
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. ,
Running: All Diagnostics are still running. ,
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 is an optional map which can be used to add key and value to request body to improve the diagnostics results ,
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. ,
Running: All Diagnostics are still running. ,
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: scope = resourceUri of affected resource.
For example: /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read ,
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 is an optional map which can be used to add key and value to request body to improve the diagnostics results ,
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. ,
Running: All Diagnostics are still running. ,
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 :  Lists the relevant Azure diagnostics and solutions using [problemClassification API](https://learn.microsoft.com/rest/api/support/problem-classifications/list?tabs=HTTP)) AND resourceUri or resourceType.
Discovery Solutions is the initial entry point within Help API, which identifies relevant Azure diagnostics and solutions.

Required Input : problemClassificationId (Use the [problemClassification API](https://learn.microsoft.com/rest/api/support/problem-classifications/list?tabs=HTTP))
Optional input: resourceUri OR resource Type

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

⚼ Request

GET:  /{scope}/providers/Microsoft.Help/discoverySolutions
{
scope:
{
Description: scope = resourceUri of affected resource.
For example: /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
$filter:
{
Description: 'ProblemClassificationId' is a mandatory filter to get solutions ids. It also supports optional 'ResourceType' and 'SolutionType' filters. The [$filter](https://learn.microsoft.com/en-us/odata/webapi/first-odata-api#filter) supports only 'and', 'or' and 'eq' operators. Example: $filter=ProblemClassificationId eq '1ddda5b4-cf6c-4d4f-91ad-bc38ab0e811e' ,
Required: False ,
}
string ,
$skiptoken:
{
Description: Skiptoken is only used if a previous operation returned a partial result. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of metadata. ,
Required: False ,
}
[
{
properties:
{
Description: Solution metadata Resource properties. ,
Required: False ,
}
{
solutions:
{
Description: List of metadata. ,
Required: False ,
}
[
{
solutionId:
{
Description: Solution Id. ,
Required: False ,
}
string ,
solutionType:
{
Description: Solution Type. ,
Enum:
{
Diagnostics: Diagnostics resource type. ,
Solutions: Solutions resource type. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: A detailed description of solution. ,
Required: False ,
}
string ,
requiredInputs:
{
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 ,
}
,
]
,
}
,
}
Solution_Create (removed)
Description :  Creates a solution for the specific Azure resource or subscription using the inputs ‘solutionId and requiredInputs’ from discovery solutions.
Azure solutions comprise a comprehensive library of self-help resources that have been thoughtfully curated by Azure engineers to aid customers in resolving typical troubleshooting issues. These solutions encompass (1.) dynamic and context-aware diagnostics, guided troubleshooting wizards, and data visualizations, (2.) rich instructional video tutorials and illustrative diagrams and images, and (3.) thoughtfully assembled textual troubleshooting instructions. All these components are seamlessly converged into unified solutions tailored to address a specific support problem area. Each solution type may require one or more ‘requiredParameters’ that are required to execute the individual solution component. In the absence of the ‘requiredParameters’ it is likely that some of the solutions might fail execution, and you might see an empty response.

Note:
1. ‘requiredInputs’ from Discovery solutions response must be passed via ‘parameters’ in the request body of Solutions API.
2. ‘requiredParameters’ from the Solutions response is the same as ‘ additionalParameters’ in the request for diagnostics
3. ‘requiredParameters’ from the Solutions response is the same as ‘properties.parameters’ in the request for Troubleshooters
Reference :  Link ¶

⚼ Request

PUT:  /{scope}/providers/Microsoft.Help/solutions/{solutionResourceName}
{
scope:
{
Description: scope = resourceUri of affected resource.
For example: /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read ,
Required: True ,
}
string ,
solutionResourceName:
{
Description: Solution resource Name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
solutionRequestBody:
{
Description: The required request body for this solution resource creation. ,
Required: False ,
}
{
properties:
{
Description: Solution result ,
Required: False ,
}
{
triggerCriteria:
{
Description: Solution request trigger criteria ,
Required: False ,
}
[
{
name:
{
Description: Trigger criterion name. ,
Enum:
{
SolutionId: No description available. ,
ProblemClassificationId: No description available. ,
ReplacementKey: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: Trigger criterion value. ,
Required: False ,
}
string ,
}
,
]
,
parameters:
{
Description: Client input parameters to run Solution ,
Required: False ,
}
object ,
solutionId:
{
Description: Solution Id to identify single solution. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Status of solution provisioning. ,
Enum:
{
Succeeded: All Solutions in the Batch succeeded. ,
PartialComplete: Some Solutions are still running or failed. ,
Failed: All Solutions failed to run. ,
Running: All Solutions are still running. ,
Canceled: When Solutions request gets canceled. ,
}
,
Required: False ,
}
enum ,
title:
{
Description: The title. ,
Required: False ,
}
string ,
content:
{
Description: The HTML content that needs to be rendered and shown to customer. ,
Required: False ,
}
string ,
replacementMaps:
{
Description: Solution replacement maps. ,
Required: False ,
}
{
webResults:
{
Description: Solution AzureKB results ,
Required: False ,
}
[
{
replacementKey:
{
Description: Place holder used in HTML Content replace control with the content ,
Required: False ,
}
string ,
searchResults:
{
Description: AzureKB search results ,
Required: False ,
}
[
{
solutionId:
{
Description: Unique id of the result. ,
Required: False ,
}
string ,
content:
{
Description: Content of the search result. ,
Required: False ,
}
string ,
title:
{
Description: Title of the search result. ,
Required: False ,
}
string ,
confidence:
{
Description: Confidence of the search result. ,
Enum:
{
Low: No description available. ,
Medium: No description available. ,
High: No description available. ,
}
,
Required: False ,
}
enum ,
source:
{
Description: Source of the search result. ,
Required: False ,
}
string ,
resultType:
{
Description: Result type of the search result. ,
Enum:
{
Community: No description available. ,
Documentation: No description available. ,
}
,
Required: False ,
}
enum ,
rank:
{
Description: rank of the search result ,
Format: int32 ,
Required: False ,
}
integer ,
link:
{
Description: Link to the document. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
diagnostics:
{
Description: Solution diagnostics results. ,
Required: False ,
}
[
{
solutionId:
{
Description: Solution Id to identify single Solutions Diagnostic ,
Required: False ,
}
string ,
status:
{
Description: The status of the resource. ,
Enum:
{
Failed: No description available. ,
MissingInputs: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: Details of the status ,
Required: False ,
}
string ,
replacementKey:
{
Description: Place holder used in HTML Content replace control with the content ,
Required: False ,
}
string ,
requiredParameters:
{
Description: Required parameters of this item ,
Required: False ,
}
[
string ,
]
,
insights:
{
Description: Diagnostic insights ,
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 ,
}
,
]
,
}
,
]
,
troubleshooters:
{
Description: Solutions Troubleshooters ,
Required: False ,
}
[
{
solutionId:
{
Description: Solution Id to identify single Solutions Troubleshooter ,
Required: False ,
}
string ,
title:
{
Description: Troubleshooter title ,
Required: False ,
}
string ,
summary:
{
Description: Troubleshooter summary ,
Required: False ,
}
string ,
}
,
]
,
metricsBasedCharts:
{
Description: Solution metrics based charts ,
Required: False ,
}
[
{
name:
{
Description: Chart name ,
Required: False ,
}
string ,
aggregationType:
{
Description: Allowed values are Sum, Avg, Count, Min, Max. Default is Sum ,
Enum:
{
Sum: No description available. ,
Avg: No description available. ,
Count: No description available. ,
Min: No description available. ,
Max: No description available. ,
}
,
Required: False ,
}
enum ,
timeSpanDuration:
{
Description: Time span duration ,
Required: False ,
}
string ,
title:
{
Description: Chart title ,
Required: False ,
}
string ,
filterGroup:
{
Description: Filter group ,
Required: False ,
}
{
filter:
{
Description: List of filters ,
Required: False ,
}
[
{
name:
{
Description: Filter name ,
Required: False ,
}
string ,
values:
{
Description: Filter values ,
Required: False ,
}
string ,
operator:
{
Description: Filter operator ,
Required: False ,
}
string ,
}
,
]
,
}
,
replacementKey:
{
Description: Place holder used in HTML Content replace control with the content ,
Required: False ,
}
string ,
}
,
]
,
videos:
{
Description: Video solutions, which have the power to engage the customer by stimulating their senses ,
Required: False ,
}
[
{
replacementKey:
{
Description: Place holder used in HTML Content replace control with the insight content ,
Required: False ,
}
string ,
}
,
]
,
videoGroups:
{
Description: Group of Videos ,
Required: False ,
}
[
{
videos:
{
Description: List of videos will be shown to customers ,
Required: False ,
}
[
{
src:
{
Description: Link to the video ,
Required: False ,
}
string ,
title:
{
Description: Title of the video ,
Required: False ,
}
string ,
}
,
]
,
replacementKey:
{
Description: Place holder used in HTML Content replace control with the insight content ,
Required: False ,
}
string ,
}
,
]
,
}
,
sections:
{
Description: List of section object. ,
Required: False ,
}
[
{
title:
{
Description: Solution sections title. ,
Required: False ,
}
string ,
content:
{
Description: Solution sections content. ,
Required: False ,
}
string ,
replacementMaps:
{
Description: Solution replacement maps. ,
Required: False ,
}
{
webResults:
{
Description: Solution AzureKB results ,
Required: False ,
}
[
{
replacementKey:
{
Description: Place holder used in HTML Content replace control with the content ,
Required: False ,
}
string ,
searchResults:
{
Description: AzureKB search results ,
Required: False ,
}
[
{
solutionId:
{
Description: Unique id of the result. ,
Required: False ,
}
string ,
content:
{
Description: Content of the search result. ,
Required: False ,
}
string ,
title:
{
Description: Title of the search result. ,
Required: False ,
}
string ,
confidence:
{
Description: Confidence of the search result. ,
Enum:
{
Low: No description available. ,
Medium: No description available. ,
High: No description available. ,
}
,
Required: False ,
}
enum ,
source:
{
Description: Source of the search result. ,
Required: False ,
}
string ,
resultType:
{
Description: Result type of the search result. ,
Enum:
{
Community: No description available. ,
Documentation: No description available. ,
}
,
Required: False ,
}
enum ,
rank:
{
Description: rank of the search result ,
Format: int32 ,
Required: False ,
}
integer ,
link:
{
Description: Link to the document. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
diagnostics:
{
Description: Solution diagnostics results. ,
Required: False ,
}
[
{
solutionId:
{
Description: Solution Id to identify single Solutions Diagnostic ,
Required: False ,
}
string ,
status:
{
Description: The status of the resource. ,
Enum:
{
Failed: No description available. ,
MissingInputs: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: Details of the status ,
Required: False ,
}
string ,
replacementKey:
{
Description: Place holder used in HTML Content replace control with the content ,
Required: False ,
}
string ,
requiredParameters:
{
Description: Required parameters of this item ,
Required: False ,
}
[
string ,
]
,
insights:
{
Description: Diagnostic insights ,
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 ,
}
,
]
,
}
,
]
,
troubleshooters:
{
Description: Solutions Troubleshooters ,
Required: False ,
}
[
{
solutionId:
{
Description: Solution Id to identify single Solutions Troubleshooter ,
Required: False ,
}
string ,
title:
{
Description: Troubleshooter title ,
Required: False ,
}
string ,
summary:
{
Description: Troubleshooter summary ,
Required: False ,
}
string ,
}
,
]
,
metricsBasedCharts:
{
Description: Solution metrics based charts ,
Required: False ,
}
[
{
name:
{
Description: Chart name ,
Required: False ,
}
string ,
aggregationType:
{
Description: Allowed values are Sum, Avg, Count, Min, Max. Default is Sum ,
Enum:
{
Sum: No description available. ,
Avg: No description available. ,
Count: No description available. ,
Min: No description available. ,
Max: No description available. ,
}
,
Required: False ,
}
enum ,
timeSpanDuration:
{
Description: Time span duration ,
Required: False ,
}
string ,
title:
{
Description: Chart title ,
Required: False ,
}
string ,
filterGroup:
{
Description: Filter group ,
Required: False ,
}
{
filter:
{
Description: List of filters ,
Required: False ,
}
[
{
name:
{
Description: Filter name ,
Required: False ,
}
string ,
values:
{
Description: Filter values ,
Required: False ,
}
string ,
operator:
{
Description: Filter operator ,
Required: False ,
}
string ,
}
,
]
,
}
,
replacementKey:
{
Description: Place holder used in HTML Content replace control with the content ,
Required: False ,
}
string ,
}
,
]
,
videos:
{
Description: Video solutions, which have the power to engage the customer by stimulating their senses ,
Required: False ,
}
[
{
replacementKey:
{
Description: Place holder used in HTML Content replace control with the insight content ,
Required: False ,
}
string ,
}
,
]
,
videoGroups:
{
Description: Group of Videos ,
Required: False ,
}
[
{
videos:
{
Description: List of videos will be shown to customers ,
Required: False ,
}
[
{
src:
{
Description: Link to the video ,
Required: False ,
}
string ,
title:
{
Description: Title of the video ,
Required: False ,
}
string ,
}
,
]
,
replacementKey:
{
Description: Place holder used in HTML Content replace control with the insight content ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Solution result ,
Required: False ,
}
{
triggerCriteria:
{
Description: Solution request trigger criteria ,
Required: False ,
}
[
{
name:
{
Description: Trigger criterion name. ,
Enum:
{
SolutionId: No description available. ,
ProblemClassificationId: No description available. ,
ReplacementKey: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: Trigger criterion value. ,
Required: False ,
}
string ,
}
,
]
,
parameters:
{
Description: Client input parameters to run Solution ,
Required: False ,
}
object ,
solutionId:
{
Description: Solution Id to identify single solution. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Status of solution provisioning. ,
Enum:
{
Succeeded: All Solutions in the Batch succeeded. ,
PartialComplete: Some Solutions are still running or failed. ,
Failed: All Solutions failed to run. ,
Running: All Solutions are still running. ,
Canceled: When Solutions request gets canceled. ,
}
,
Required: False ,
}
enum ,
title:
{
Description: The title. ,
Required: False ,
}
string ,
content:
{
Description: The HTML content that needs to be rendered and shown to customer. ,
Required: False ,
}
string ,
replacementMaps:
{
Description: Solution replacement maps. ,
Required: False ,
}
{
webResults:
{
Description: Solution AzureKB results ,
Required: False ,
}
[
{
replacementKey:
{
Description: Place holder used in HTML Content replace control with the content ,
Required: False ,
}
string ,
searchResults:
{
Description: AzureKB search results ,
Required: False ,
}
[
{
solutionId:
{
Description: Unique id of the result. ,
Required: False ,
}
string ,
content:
{
Description: Content of the search result. ,
Required: False ,
}
string ,
title:
{
Description: Title of the search result. ,
Required: False ,
}
string ,
confidence:
{
Description: Confidence of the search result. ,
Enum:
{
Low: No description available. ,
Medium: No description available. ,
High: No description available. ,
}
,
Required: False ,
}
enum ,
source:
{
Description: Source of the search result. ,
Required: False ,
}
string ,
resultType:
{
Description: Result type of the search result. ,
Enum:
{
Community: No description available. ,
Documentation: No description available. ,
}
,
Required: False ,
}
enum ,
rank:
{
Description: rank of the search result ,
Format: int32 ,
Required: False ,
}
integer ,
link:
{
Description: Link to the document. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
diagnostics:
{
Description: Solution diagnostics results. ,
Required: False ,
}
[
{
solutionId:
{
Description: Solution Id to identify single Solutions Diagnostic ,
Required: False ,
}
string ,
status:
{
Description: The status of the resource. ,
Enum:
{
Failed: No description available. ,
MissingInputs: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: Details of the status ,
Required: False ,
}
string ,
replacementKey:
{
Description: Place holder used in HTML Content replace control with the content ,
Required: False ,
}
string ,
requiredParameters:
{
Description: Required parameters of this item ,
Required: False ,
}
[
string ,
]
,
insights:
{
Description: Diagnostic insights ,
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 ,
}
,
]
,
}
,
]
,
troubleshooters:
{
Description: Solutions Troubleshooters ,
Required: False ,
}
[
{
solutionId:
{
Description: Solution Id to identify single Solutions Troubleshooter ,
Required: False ,
}
string ,
title:
{
Description: Troubleshooter title ,
Required: False ,
}
string ,
summary:
{
Description: Troubleshooter summary ,
Required: False ,
}
string ,
}
,
]
,
metricsBasedCharts:
{
Description: Solution metrics based charts ,
Required: False ,
}
[
{
name:
{
Description: Chart name ,
Required: False ,
}
string ,
aggregationType:
{
Description: Allowed values are Sum, Avg, Count, Min, Max. Default is Sum ,
Enum:
{
Sum: No description available. ,
Avg: No description available. ,
Count: No description available. ,
Min: No description available. ,
Max: No description available. ,
}
,
Required: False ,
}
enum ,
timeSpanDuration:
{
Description: Time span duration ,
Required: False ,
}
string ,
title:
{
Description: Chart title ,
Required: False ,
}
string ,
filterGroup:
{
Description: Filter group ,
Required: False ,
}
{
filter:
{
Description: List of filters ,
Required: False ,
}
[
{
name:
{
Description: Filter name ,
Required: False ,
}
string ,
values:
{
Description: Filter values ,
Required: False ,
}
string ,
operator:
{
Description: Filter operator ,
Required: False ,
}
string ,
}
,
]
,
}
,
replacementKey:
{
Description: Place holder used in HTML Content replace control with the content ,
Required: False ,
}
string ,
}
,
]
,
videos:
{
Description: Video solutions, which have the power to engage the customer by stimulating their senses ,
Required: False ,
}
[
{
replacementKey:
{
Description: Place holder used in HTML Content replace control with the insight content ,
Required: False ,
}
string ,
}
,
]
,
videoGroups:
{
Description: Group of Videos ,
Required: False ,
}
[
{
videos:
{
Description: List of videos will be shown to customers ,
Required: False ,
}
[
{
src:
{
Description: Link to the video ,
Required: False ,
}
string ,
title:
{
Description: Title of the video ,
Required: False ,
}
string ,
}
,
]
,
replacementKey:
{
Description: Place holder used in HTML Content replace control with the insight content ,
Required: False ,
}
string ,
}
,
]
,
}
,
sections:
{
Description: List of section object. ,
Required: False ,
}
[
{
title:
{
Description: Solution sections title. ,
Required: False ,
}
string ,
content:
{
Description: Solution sections content. ,
Required: False ,
}
string ,
replacementMaps:
{
Description: Solution replacement maps. ,
Required: False ,
}
{
webResults:
{
Description: Solution AzureKB results ,
Required: False ,
}
[
{
replacementKey:
{
Description: Place holder used in HTML Content replace control with the content ,
Required: False ,
}
string ,
searchResults:
{
Description: AzureKB search results ,
Required: False ,
}
[
{
solutionId:
{
Description: Unique id of the result. ,
Required: False ,
}
string ,
content:
{
Description: Content of the search result. ,
Required: False ,
}
string ,
title:
{
Description: Title of the search result. ,
Required: False ,
}
string ,
confidence:
{
Description: Confidence of the search result. ,
Enum:
{
Low: No description available. ,
Medium: No description available. ,
High: No description available. ,
}
,
Required: False ,
}
enum ,
source:
{
Description: Source of the search result. ,
Required: False ,
}
string ,
resultType:
{
Description: Result type of the search result. ,
Enum:
{
Community: No description available. ,
Documentation: No description available. ,
}
,
Required: False ,
}
enum ,
rank:
{
Description: rank of the search result ,
Format: int32 ,
Required: False ,
}
integer ,
link:
{
Description: Link to the document. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
diagnostics:
{
Description: Solution diagnostics results. ,
Required: False ,
}
[
{
solutionId:
{
Description: Solution Id to identify single Solutions Diagnostic ,
Required: False ,
}
string ,
status:
{
Description: The status of the resource. ,
Enum:
{
Failed: No description available. ,
MissingInputs: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: Details of the status ,
Required: False ,
}
string ,
replacementKey:
{
Description: Place holder used in HTML Content replace control with the content ,
Required: False ,
}
string ,
requiredParameters:
{
Description: Required parameters of this item ,
Required: False ,
}
[
string ,
]
,
insights:
{
Description: Diagnostic insights ,
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 ,
}
,
]
,
}
,
]
,
troubleshooters:
{
Description: Solutions Troubleshooters ,
Required: False ,
}
[
{
solutionId:
{
Description: Solution Id to identify single Solutions Troubleshooter ,
Required: False ,
}
string ,
title:
{
Description: Troubleshooter title ,
Required: False ,
}
string ,
summary:
{
Description: Troubleshooter summary ,
Required: False ,
}
string ,
}
,
]
,
metricsBasedCharts:
{
Description: Solution metrics based charts ,
Required: False ,
}
[
{
name:
{
Description: Chart name ,
Required: False ,
}
string ,
aggregationType:
{
Description: Allowed values are Sum, Avg, Count, Min, Max. Default is Sum ,
Enum:
{
Sum: No description available. ,
Avg: No description available. ,
Count: No description available. ,
Min: No description available. ,
Max: No description available. ,
}
,
Required: False ,
}
enum ,
timeSpanDuration:
{
Description: Time span duration ,
Required: False ,
}
string ,
title:
{
Description: Chart title ,
Required: False ,
}
string ,
filterGroup:
{
Description: Filter group ,
Required: False ,
}
{
filter:
{
Description: List of filters ,
Required: False ,
}
[
{
name:
{
Description: Filter name ,
Required: False ,
}
string ,
values:
{
Description: Filter values ,
Required: False ,
}
string ,
operator:
{
Description: Filter operator ,
Required: False ,
}
string ,
}
,
]
,
}
,
replacementKey:
{
Description: Place holder used in HTML Content replace control with the content ,
Required: False ,
}
string ,
}
,
]
,
videos:
{
Description: Video solutions, which have the power to engage the customer by stimulating their senses ,
Required: False ,
}
[
{
replacementKey:
{
Description: Place holder used in HTML Content replace control with the insight content ,
Required: False ,
}
string ,
}
,
]
,
videoGroups:
{
Description: Group of Videos ,
Required: False ,
}
[
{
videos:
{
Description: List of videos will be shown to customers ,
Required: False ,
}
[
{
src:
{
Description: Link to the video ,
Required: False ,
}
string ,
title:
{
Description: Title of the video ,
Required: False ,
}
string ,
}
,
]
,
replacementKey:
{
Description: Place holder used in HTML Content replace control with the insight content ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Solution result ,
Required: False ,
}
{
triggerCriteria:
{
Description: Solution request trigger criteria ,
Required: False ,
}
[
{
name:
{
Description: Trigger criterion name. ,
Enum:
{
SolutionId: No description available. ,
ProblemClassificationId: No description available. ,
ReplacementKey: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: Trigger criterion value. ,
Required: False ,
}
string ,
}
,
]
,
parameters:
{
Description: Client input parameters to run Solution ,
Required: False ,
}
object ,
solutionId:
{
Description: Solution Id to identify single solution. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Status of solution provisioning. ,
Enum:
{
Succeeded: All Solutions in the Batch succeeded. ,
PartialComplete: Some Solutions are still running or failed. ,
Failed: All Solutions failed to run. ,
Running: All Solutions are still running. ,
Canceled: When Solutions request gets canceled. ,
}
,
Required: False ,
}
enum ,
title:
{
Description: The title. ,
Required: False ,
}
string ,
content:
{
Description: The HTML content that needs to be rendered and shown to customer. ,
Required: False ,
}
string ,
replacementMaps:
{
Description: Solution replacement maps. ,
Required: False ,
}
{
webResults:
{
Description: Solution AzureKB results ,
Required: False ,
}
[
{
replacementKey:
{
Description: Place holder used in HTML Content replace control with the content ,
Required: False ,
}
string ,
searchResults:
{
Description: AzureKB search results ,
Required: False ,
}
[
{
solutionId:
{
Description: Unique id of the result. ,
Required: False ,
}
string ,
content:
{
Description: Content of the search result. ,
Required: False ,
}
string ,
title:
{
Description: Title of the search result. ,
Required: False ,
}
string ,
confidence:
{
Description: Confidence of the search result. ,
Enum:
{
Low: No description available. ,
Medium: No description available. ,
High: No description available. ,
}
,
Required: False ,
}
enum ,
source:
{
Description: Source of the search result. ,
Required: False ,
}
string ,
resultType:
{
Description: Result type of the search result. ,
Enum:
{
Community: No description available. ,
Documentation: No description available. ,
}
,
Required: False ,
}
enum ,
rank:
{
Description: rank of the search result ,
Format: int32 ,
Required: False ,
}
integer ,
link:
{
Description: Link to the document. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
diagnostics:
{
Description: Solution diagnostics results. ,
Required: False ,
}
[
{
solutionId:
{
Description: Solution Id to identify single Solutions Diagnostic ,
Required: False ,
}
string ,
status:
{
Description: The status of the resource. ,
Enum:
{
Failed: No description available. ,
MissingInputs: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: Details of the status ,
Required: False ,
}
string ,
replacementKey:
{
Description: Place holder used in HTML Content replace control with the content ,
Required: False ,
}
string ,
requiredParameters:
{
Description: Required parameters of this item ,
Required: False ,
}
[
string ,
]
,
insights:
{
Description: Diagnostic insights ,
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 ,
}
,
]
,
}
,
]
,
troubleshooters:
{
Description: Solutions Troubleshooters ,
Required: False ,
}
[
{
solutionId:
{
Description: Solution Id to identify single Solutions Troubleshooter ,
Required: False ,
}
string ,
title:
{
Description: Troubleshooter title ,
Required: False ,
}
string ,
summary:
{
Description: Troubleshooter summary ,
Required: False ,
}
string ,
}
,
]
,
metricsBasedCharts:
{
Description: Solution metrics based charts ,
Required: False ,
}
[
{
name:
{
Description: Chart name ,
Required: False ,
}
string ,
aggregationType:
{
Description: Allowed values are Sum, Avg, Count, Min, Max. Default is Sum ,
Enum:
{
Sum: No description available. ,
Avg: No description available. ,
Count: No description available. ,
Min: No description available. ,
Max: No description available. ,
}
,
Required: False ,
}
enum ,
timeSpanDuration:
{
Description: Time span duration ,
Required: False ,
}
string ,
title:
{
Description: Chart title ,
Required: False ,
}
string ,
filterGroup:
{
Description: Filter group ,
Required: False ,
}
{
filter:
{
Description: List of filters ,
Required: False ,
}
[
{
name:
{
Description: Filter name ,
Required: False ,
}
string ,
values:
{
Description: Filter values ,
Required: False ,
}
string ,
operator:
{
Description: Filter operator ,
Required: False ,
}
string ,
}
,
]
,
}
,
replacementKey:
{
Description: Place holder used in HTML Content replace control with the content ,
Required: False ,
}
string ,
}
,
]
,
videos:
{
Description: Video solutions, which have the power to engage the customer by stimulating their senses ,
Required: False ,
}
[
{
replacementKey:
{
Description: Place holder used in HTML Content replace control with the insight content ,
Required: False ,
}
string ,
}
,
]
,
videoGroups:
{
Description: Group of Videos ,
Required: False ,
}
[
{
videos:
{
Description: List of videos will be shown to customers ,
Required: False ,
}
[
{
src:
{
Description: Link to the video ,
Required: False ,
}
string ,
title:
{
Description: Title of the video ,
Required: False ,
}
string ,
}
,
]
,
replacementKey:
{
Description: Place holder used in HTML Content replace control with the insight content ,
Required: False ,
}
string ,
}
,
]
,
}
,
sections:
{
Description: List of section object. ,
Required: False ,
}
[
{
title:
{
Description: Solution sections title. ,
Required: False ,
}
string ,
content:
{
Description: Solution sections content. ,
Required: False ,
}
string ,
replacementMaps:
{
Description: Solution replacement maps. ,
Required: False ,
}
{
webResults:
{
Description: Solution AzureKB results ,
Required: False ,
}
[
{
replacementKey:
{
Description: Place holder used in HTML Content replace control with the content ,
Required: False ,
}
string ,
searchResults:
{
Description: AzureKB search results ,
Required: False ,
}
[
{
solutionId:
{
Description: Unique id of the result. ,
Required: False ,
}
string ,
content:
{
Description: Content of the search result. ,
Required: False ,
}
string ,
title:
{
Description: Title of the search result. ,
Required: False ,
}
string ,
confidence:
{
Description: Confidence of the search result. ,
Enum:
{
Low: No description available. ,
Medium: No description available. ,
High: No description available. ,
}
,
Required: False ,
}
enum ,
source:
{
Description: Source of the search result. ,
Required: False ,
}
string ,
resultType:
{
Description: Result type of the search result. ,
Enum:
{
Community: No description available. ,
Documentation: No description available. ,
}
,
Required: False ,
}
enum ,
rank:
{
Description: rank of the search result ,
Format: int32 ,
Required: False ,
}
integer ,
link:
{
Description: Link to the document. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
diagnostics:
{
Description: Solution diagnostics results. ,
Required: False ,
}
[
{
solutionId:
{
Description: Solution Id to identify single Solutions Diagnostic ,
Required: False ,
}
string ,
status:
{
Description: The status of the resource. ,
Enum:
{
Failed: No description available. ,
MissingInputs: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: Details of the status ,
Required: False ,
}
string ,
replacementKey:
{
Description: Place holder used in HTML Content replace control with the content ,
Required: False ,
}
string ,
requiredParameters:
{
Description: Required parameters of this item ,
Required: False ,
}
[
string ,
]
,
insights:
{
Description: Diagnostic insights ,
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 ,
}
,
]
,
}
,
]
,
troubleshooters:
{
Description: Solutions Troubleshooters ,
Required: False ,
}
[
{
solutionId:
{
Description: Solution Id to identify single Solutions Troubleshooter ,
Required: False ,
}
string ,
title:
{
Description: Troubleshooter title ,
Required: False ,
}
string ,
summary:
{
Description: Troubleshooter summary ,
Required: False ,
}
string ,
}
,
]
,
metricsBasedCharts:
{
Description: Solution metrics based charts ,
Required: False ,
}
[
{
name:
{
Description: Chart name ,
Required: False ,
}
string ,
aggregationType:
{
Description: Allowed values are Sum, Avg, Count, Min, Max. Default is Sum ,
Enum:
{
Sum: No description available. ,
Avg: No description available. ,
Count: No description available. ,
Min: No description available. ,
Max: No description available. ,
}
,
Required: False ,
}
enum ,
timeSpanDuration:
{
Description: Time span duration ,
Required: False ,
}
string ,
title:
{
Description: Chart title ,
Required: False ,
}
string ,
filterGroup:
{
Description: Filter group ,
Required: False ,
}
{
filter:
{
Description: List of filters ,
Required: False ,
}
[
{
name:
{
Description: Filter name ,
Required: False ,
}
string ,
values:
{
Description: Filter values ,
Required: False ,
}
string ,
operator:
{
Description: Filter operator ,
Required: False ,
}
string ,
}
,
]
,
}
,
replacementKey:
{
Description: Place holder used in HTML Content replace control with the content ,
Required: False ,
}
string ,
}
,
]
,
videos:
{
Description: Video solutions, which have the power to engage the customer by stimulating their senses ,
Required: False ,
}
[
{
replacementKey:
{
Description: Place holder used in HTML Content replace control with the insight content ,
Required: False ,
}
string ,
}
,
]
,
videoGroups:
{
Description: Group of Videos ,
Required: False ,
}
[
{
videos:
{
Description: List of videos will be shown to customers ,
Required: False ,
}
[
{
src:
{
Description: Link to the video ,
Required: False ,
}
string ,
title:
{
Description: Title of the video ,
Required: False ,
}
string ,
}
,
]
,
replacementKey:
{
Description: Place holder used in HTML Content replace control with the insight content ,
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 ,
}
,
]
,
}
,
}
Solution_Get (removed)
Description :  Get the solution using the applicable solutionResourceName while creating the solution.
Reference :  Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.Help/solutions/{solutionResourceName}
{
scope:
{
Description: scope = resourceUri of affected resource.
For example: /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read ,
Required: True ,
}
string ,
solutionResourceName:
{
Description: Solution resource Name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Solution result ,
Required: False ,
}
{
triggerCriteria:
{
Description: Solution request trigger criteria ,
Required: False ,
}
[
{
name:
{
Description: Trigger criterion name. ,
Enum:
{
SolutionId: No description available. ,
ProblemClassificationId: No description available. ,
ReplacementKey: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: Trigger criterion value. ,
Required: False ,
}
string ,
}
,
]
,
parameters:
{
Description: Client input parameters to run Solution ,
Required: False ,
}
object ,
solutionId:
{
Description: Solution Id to identify single solution. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Status of solution provisioning. ,
Enum:
{
Succeeded: All Solutions in the Batch succeeded. ,
PartialComplete: Some Solutions are still running or failed. ,
Failed: All Solutions failed to run. ,
Running: All Solutions are still running. ,
Canceled: When Solutions request gets canceled. ,
}
,
Required: False ,
}
enum ,
title:
{
Description: The title. ,
Required: False ,
}
string ,
content:
{
Description: The HTML content that needs to be rendered and shown to customer. ,
Required: False ,
}
string ,
replacementMaps:
{
Description: Solution replacement maps. ,
Required: False ,
}
{
webResults:
{
Description: Solution AzureKB results ,
Required: False ,
}
[
{
replacementKey:
{
Description: Place holder used in HTML Content replace control with the content ,
Required: False ,
}
string ,
searchResults:
{
Description: AzureKB search results ,
Required: False ,
}
[
{
solutionId:
{
Description: Unique id of the result. ,
Required: False ,
}
string ,
content:
{
Description: Content of the search result. ,
Required: False ,
}
string ,
title:
{
Description: Title of the search result. ,
Required: False ,
}
string ,
confidence:
{
Description: Confidence of the search result. ,
Enum:
{
Low: No description available. ,
Medium: No description available. ,
High: No description available. ,
}
,
Required: False ,
}
enum ,
source:
{
Description: Source of the search result. ,
Required: False ,
}
string ,
resultType:
{
Description: Result type of the search result. ,
Enum:
{
Community: No description available. ,
Documentation: No description available. ,
}
,
Required: False ,
}
enum ,
rank:
{
Description: rank of the search result ,
Format: int32 ,
Required: False ,
}
integer ,
link:
{
Description: Link to the document. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
diagnostics:
{
Description: Solution diagnostics results. ,
Required: False ,
}
[
{
solutionId:
{
Description: Solution Id to identify single Solutions Diagnostic ,
Required: False ,
}
string ,
status:
{
Description: The status of the resource. ,
Enum:
{
Failed: No description available. ,
MissingInputs: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: Details of the status ,
Required: False ,
}
string ,
replacementKey:
{
Description: Place holder used in HTML Content replace control with the content ,
Required: False ,
}
string ,
requiredParameters:
{
Description: Required parameters of this item ,
Required: False ,
}
[
string ,
]
,
insights:
{
Description: Diagnostic insights ,
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 ,
}
,
]
,
}
,
]
,
troubleshooters:
{
Description: Solutions Troubleshooters ,
Required: False ,
}
[
{
solutionId:
{
Description: Solution Id to identify single Solutions Troubleshooter ,
Required: False ,
}
string ,
title:
{
Description: Troubleshooter title ,
Required: False ,
}
string ,
summary:
{
Description: Troubleshooter summary ,
Required: False ,
}
string ,
}
,
]
,
metricsBasedCharts:
{
Description: Solution metrics based charts ,
Required: False ,
}
[
{
name:
{
Description: Chart name ,
Required: False ,
}
string ,
aggregationType:
{
Description: Allowed values are Sum, Avg, Count, Min, Max. Default is Sum ,
Enum:
{
Sum: No description available. ,
Avg: No description available. ,
Count: No description available. ,
Min: No description available. ,
Max: No description available. ,
}
,
Required: False ,
}
enum ,
timeSpanDuration:
{
Description: Time span duration ,
Required: False ,
}
string ,
title:
{
Description: Chart title ,
Required: False ,
}
string ,
filterGroup:
{
Description: Filter group ,
Required: False ,
}
{
filter:
{
Description: List of filters ,
Required: False ,
}
[
{
name:
{
Description: Filter name ,
Required: False ,
}
string ,
values:
{
Description: Filter values ,
Required: False ,
}
string ,
operator:
{
Description: Filter operator ,
Required: False ,
}
string ,
}
,
]
,
}
,
replacementKey:
{
Description: Place holder used in HTML Content replace control with the content ,
Required: False ,
}
string ,
}
,
]
,
videos:
{
Description: Video solutions, which have the power to engage the customer by stimulating their senses ,
Required: False ,
}
[
{
replacementKey:
{
Description: Place holder used in HTML Content replace control with the insight content ,
Required: False ,
}
string ,
}
,
]
,
videoGroups:
{
Description: Group of Videos ,
Required: False ,
}
[
{
videos:
{
Description: List of videos will be shown to customers ,
Required: False ,
}
[
{
src:
{
Description: Link to the video ,
Required: False ,
}
string ,
title:
{
Description: Title of the video ,
Required: False ,
}
string ,
}
,
]
,
replacementKey:
{
Description: Place holder used in HTML Content replace control with the insight content ,
Required: False ,
}
string ,
}
,
]
,
}
,
sections:
{
Description: List of section object. ,
Required: False ,
}
[
{
title:
{
Description: Solution sections title. ,
Required: False ,
}
string ,
content:
{
Description: Solution sections content. ,
Required: False ,
}
string ,
replacementMaps:
{
Description: Solution replacement maps. ,
Required: False ,
}
{
webResults:
{
Description: Solution AzureKB results ,
Required: False ,
}
[
{
replacementKey:
{
Description: Place holder used in HTML Content replace control with the content ,
Required: False ,
}
string ,
searchResults:
{
Description: AzureKB search results ,
Required: False ,
}
[
{
solutionId:
{
Description: Unique id of the result. ,
Required: False ,
}
string ,
content:
{
Description: Content of the search result. ,
Required: False ,
}
string ,
title:
{
Description: Title of the search result. ,
Required: False ,
}
string ,
confidence:
{
Description: Confidence of the search result. ,
Enum:
{
Low: No description available. ,
Medium: No description available. ,
High: No description available. ,
}
,
Required: False ,
}
enum ,
source:
{
Description: Source of the search result. ,
Required: False ,
}
string ,
resultType:
{
Description: Result type of the search result. ,
Enum:
{
Community: No description available. ,
Documentation: No description available. ,
}
,
Required: False ,
}
enum ,
rank:
{
Description: rank of the search result ,
Format: int32 ,
Required: False ,
}
integer ,
link:
{
Description: Link to the document. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
diagnostics:
{
Description: Solution diagnostics results. ,
Required: False ,
}
[
{
solutionId:
{
Description: Solution Id to identify single Solutions Diagnostic ,
Required: False ,
}
string ,
status:
{
Description: The status of the resource. ,
Enum:
{
Failed: No description available. ,
MissingInputs: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: Details of the status ,
Required: False ,
}
string ,
replacementKey:
{
Description: Place holder used in HTML Content replace control with the content ,
Required: False ,
}
string ,
requiredParameters:
{
Description: Required parameters of this item ,
Required: False ,
}
[
string ,
]
,
insights:
{
Description: Diagnostic insights ,
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 ,
}
,
]
,
}
,
]
,
troubleshooters:
{
Description: Solutions Troubleshooters ,
Required: False ,
}
[
{
solutionId:
{
Description: Solution Id to identify single Solutions Troubleshooter ,
Required: False ,
}
string ,
title:
{
Description: Troubleshooter title ,
Required: False ,
}
string ,
summary:
{
Description: Troubleshooter summary ,
Required: False ,
}
string ,
}
,
]
,
metricsBasedCharts:
{
Description: Solution metrics based charts ,
Required: False ,
}
[
{
name:
{
Description: Chart name ,
Required: False ,
}
string ,
aggregationType:
{
Description: Allowed values are Sum, Avg, Count, Min, Max. Default is Sum ,
Enum:
{
Sum: No description available. ,
Avg: No description available. ,
Count: No description available. ,
Min: No description available. ,
Max: No description available. ,
}
,
Required: False ,
}
enum ,
timeSpanDuration:
{
Description: Time span duration ,
Required: False ,
}
string ,
title:
{
Description: Chart title ,
Required: False ,
}
string ,
filterGroup:
{
Description: Filter group ,
Required: False ,
}
{
filter:
{
Description: List of filters ,
Required: False ,
}
[
{
name:
{
Description: Filter name ,
Required: False ,
}
string ,
values:
{
Description: Filter values ,
Required: False ,
}
string ,
operator:
{
Description: Filter operator ,
Required: False ,
}
string ,
}
,
]
,
}
,
replacementKey:
{
Description: Place holder used in HTML Content replace control with the content ,
Required: False ,
}
string ,
}
,
]
,
videos:
{
Description: Video solutions, which have the power to engage the customer by stimulating their senses ,
Required: False ,
}
[
{
replacementKey:
{
Description: Place holder used in HTML Content replace control with the insight content ,
Required: False ,
}
string ,
}
,
]
,
videoGroups:
{
Description: Group of Videos ,
Required: False ,
}
[
{
videos:
{
Description: List of videos will be shown to customers ,
Required: False ,
}
[
{
src:
{
Description: Link to the video ,
Required: False ,
}
string ,
title:
{
Description: Title of the video ,
Required: False ,
}
string ,
}
,
]
,
replacementKey:
{
Description: Place holder used in HTML Content replace control with the insight content ,
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 ,
}
,
]
,
}
,
}
Solution_Update (removed)
Description :  Update the requiredInputs or additional information needed to execute the solution
Reference :  Link ¶

⚼ Request

PATCH:  /{scope}/providers/Microsoft.Help/solutions/{solutionResourceName}
{
scope:
{
Description: scope = resourceUri of affected resource.
For example: /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read ,
Required: True ,
}
string ,
solutionResourceName:
{
Description: Solution resource Name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
solutionPatchRequestBody:
{
Description: The required request body for updating a solution resource. ,
Required: False ,
}
{
properties:
{
Description: Solution result ,
Required: False ,
}
{
triggerCriteria:
{
Description: Solution request trigger criteria ,
Required: False ,
}
[
{
name:
{
Description: Trigger criterion name. ,
Enum:
{
SolutionId: No description available. ,
ProblemClassificationId: No description available. ,
ReplacementKey: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: Trigger criterion value. ,
Required: False ,
}
string ,
}
,
]
,
parameters:
{
Description: Client input parameters to run Solution ,
Required: False ,
}
object ,
solutionId:
{
Description: Solution Id to identify single solution. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Status of solution provisioning. ,
Enum:
{
Succeeded: All Solutions in the Batch succeeded. ,
PartialComplete: Some Solutions are still running or failed. ,
Failed: All Solutions failed to run. ,
Running: All Solutions are still running. ,
Canceled: When Solutions request gets canceled. ,
}
,
Required: False ,
}
enum ,
title:
{
Description: The title. ,
Required: False ,
}
string ,
content:
{
Description: The HTML content that needs to be rendered and shown to customer. ,
Required: False ,
}
string ,
replacementMaps:
{
Description: Solution replacement maps. ,
Required: False ,
}
{
webResults:
{
Description: Solution AzureKB results ,
Required: False ,
}
[
{
replacementKey:
{
Description: Place holder used in HTML Content replace control with the content ,
Required: False ,
}
string ,
searchResults:
{
Description: AzureKB search results ,
Required: False ,
}
[
{
solutionId:
{
Description: Unique id of the result. ,
Required: False ,
}
string ,
content:
{
Description: Content of the search result. ,
Required: False ,
}
string ,
title:
{
Description: Title of the search result. ,
Required: False ,
}
string ,
confidence:
{
Description: Confidence of the search result. ,
Enum:
{
Low: No description available. ,
Medium: No description available. ,
High: No description available. ,
}
,
Required: False ,
}
enum ,
source:
{
Description: Source of the search result. ,
Required: False ,
}
string ,
resultType:
{
Description: Result type of the search result. ,
Enum:
{
Community: No description available. ,
Documentation: No description available. ,
}
,
Required: False ,
}
enum ,
rank:
{
Description: rank of the search result ,
Format: int32 ,
Required: False ,
}
integer ,
link:
{
Description: Link to the document. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
diagnostics:
{
Description: Solution diagnostics results. ,
Required: False ,
}
[
{
solutionId:
{
Description: Solution Id to identify single Solutions Diagnostic ,
Required: False ,
}
string ,
status:
{
Description: The status of the resource. ,
Enum:
{
Failed: No description available. ,
MissingInputs: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: Details of the status ,
Required: False ,
}
string ,
replacementKey:
{
Description: Place holder used in HTML Content replace control with the content ,
Required: False ,
}
string ,
requiredParameters:
{
Description: Required parameters of this item ,
Required: False ,
}
[
string ,
]
,
insights:
{
Description: Diagnostic insights ,
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 ,
}
,
]
,
}
,
]
,
troubleshooters:
{
Description: Solutions Troubleshooters ,
Required: False ,
}
[
{
solutionId:
{
Description: Solution Id to identify single Solutions Troubleshooter ,
Required: False ,
}
string ,
title:
{
Description: Troubleshooter title ,
Required: False ,
}
string ,
summary:
{
Description: Troubleshooter summary ,
Required: False ,
}
string ,
}
,
]
,
metricsBasedCharts:
{
Description: Solution metrics based charts ,
Required: False ,
}
[
{
name:
{
Description: Chart name ,
Required: False ,
}
string ,
aggregationType:
{
Description: Allowed values are Sum, Avg, Count, Min, Max. Default is Sum ,
Enum:
{
Sum: No description available. ,
Avg: No description available. ,
Count: No description available. ,
Min: No description available. ,
Max: No description available. ,
}
,
Required: False ,
}
enum ,
timeSpanDuration:
{
Description: Time span duration ,
Required: False ,
}
string ,
title:
{
Description: Chart title ,
Required: False ,
}
string ,
filterGroup:
{
Description: Filter group ,
Required: False ,
}
{
filter:
{
Description: List of filters ,
Required: False ,
}
[
{
name:
{
Description: Filter name ,
Required: False ,
}
string ,
values:
{
Description: Filter values ,
Required: False ,
}
string ,
operator:
{
Description: Filter operator ,
Required: False ,
}
string ,
}
,
]
,
}
,
replacementKey:
{
Description: Place holder used in HTML Content replace control with the content ,
Required: False ,
}
string ,
}
,
]
,
videos:
{
Description: Video solutions, which have the power to engage the customer by stimulating their senses ,
Required: False ,
}
[
{
replacementKey:
{
Description: Place holder used in HTML Content replace control with the insight content ,
Required: False ,
}
string ,
}
,
]
,
videoGroups:
{
Description: Group of Videos ,
Required: False ,
}
[
{
videos:
{
Description: List of videos will be shown to customers ,
Required: False ,
}
[
{
src:
{
Description: Link to the video ,
Required: False ,
}
string ,
title:
{
Description: Title of the video ,
Required: False ,
}
string ,
}
,
]
,
replacementKey:
{
Description: Place holder used in HTML Content replace control with the insight content ,
Required: False ,
}
string ,
}
,
]
,
}
,
sections:
{
Description: List of section object. ,
Required: False ,
}
[
{
title:
{
Description: Solution sections title. ,
Required: False ,
}
string ,
content:
{
Description: Solution sections content. ,
Required: False ,
}
string ,
replacementMaps:
{
Description: Solution replacement maps. ,
Required: False ,
}
{
webResults:
{
Description: Solution AzureKB results ,
Required: False ,
}
[
{
replacementKey:
{
Description: Place holder used in HTML Content replace control with the content ,
Required: False ,
}
string ,
searchResults:
{
Description: AzureKB search results ,
Required: False ,
}
[
{
solutionId:
{
Description: Unique id of the result. ,
Required: False ,
}
string ,
content:
{
Description: Content of the search result. ,
Required: False ,
}
string ,
title:
{
Description: Title of the search result. ,
Required: False ,
}
string ,
confidence:
{
Description: Confidence of the search result. ,
Enum:
{
Low: No description available. ,
Medium: No description available. ,
High: No description available. ,
}
,
Required: False ,
}
enum ,
source:
{
Description: Source of the search result. ,
Required: False ,
}
string ,
resultType:
{
Description: Result type of the search result. ,
Enum:
{
Community: No description available. ,
Documentation: No description available. ,
}
,
Required: False ,
}
enum ,
rank:
{
Description: rank of the search result ,
Format: int32 ,
Required: False ,
}
integer ,
link:
{
Description: Link to the document. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
diagnostics:
{
Description: Solution diagnostics results. ,
Required: False ,
}
[
{
solutionId:
{
Description: Solution Id to identify single Solutions Diagnostic ,
Required: False ,
}
string ,
status:
{
Description: The status of the resource. ,
Enum:
{
Failed: No description available. ,
MissingInputs: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: Details of the status ,
Required: False ,
}
string ,
replacementKey:
{
Description: Place holder used in HTML Content replace control with the content ,
Required: False ,
}
string ,
requiredParameters:
{
Description: Required parameters of this item ,
Required: False ,
}
[
string ,
]
,
insights:
{
Description: Diagnostic insights ,
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 ,
}
,
]
,
}
,
]
,
troubleshooters:
{
Description: Solutions Troubleshooters ,
Required: False ,
}
[
{
solutionId:
{
Description: Solution Id to identify single Solutions Troubleshooter ,
Required: False ,
}
string ,
title:
{
Description: Troubleshooter title ,
Required: False ,
}
string ,
summary:
{
Description: Troubleshooter summary ,
Required: False ,
}
string ,
}
,
]
,
metricsBasedCharts:
{
Description: Solution metrics based charts ,
Required: False ,
}
[
{
name:
{
Description: Chart name ,
Required: False ,
}
string ,
aggregationType:
{
Description: Allowed values are Sum, Avg, Count, Min, Max. Default is Sum ,
Enum:
{
Sum: No description available. ,
Avg: No description available. ,
Count: No description available. ,
Min: No description available. ,
Max: No description available. ,
}
,
Required: False ,
}
enum ,
timeSpanDuration:
{
Description: Time span duration ,
Required: False ,
}
string ,
title:
{
Description: Chart title ,
Required: False ,
}
string ,
filterGroup:
{
Description: Filter group ,
Required: False ,
}
{
filter:
{
Description: List of filters ,
Required: False ,
}
[
{
name:
{
Description: Filter name ,
Required: False ,
}
string ,
values:
{
Description: Filter values ,
Required: False ,
}
string ,
operator:
{
Description: Filter operator ,
Required: False ,
}
string ,
}
,
]
,
}
,
replacementKey:
{
Description: Place holder used in HTML Content replace control with the content ,
Required: False ,
}
string ,
}
,
]
,
videos:
{
Description: Video solutions, which have the power to engage the customer by stimulating their senses ,
Required: False ,
}
[
{
replacementKey:
{
Description: Place holder used in HTML Content replace control with the insight content ,
Required: False ,
}
string ,
}
,
]
,
videoGroups:
{
Description: Group of Videos ,
Required: False ,
}
[
{
videos:
{
Description: List of videos will be shown to customers ,
Required: False ,
}
[
{
src:
{
Description: Link to the video ,
Required: False ,
}
string ,
title:
{
Description: Title of the video ,
Required: False ,
}
string ,
}
,
]
,
replacementKey:
{
Description: Place holder used in HTML Content replace control with the insight content ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
}
,
}
,
}

⚐ Response (202)

{
$headers:
{
location: string ,
}
,
$schema:
{
Description: Solution response. ,
}
{
properties:
{
Description: Solution result ,
Required: False ,
}
{
triggerCriteria:
{
Description: Solution request trigger criteria ,
Required: False ,
}
[
{
name:
{
Description: Trigger criterion name. ,
Enum:
{
SolutionId: No description available. ,
ProblemClassificationId: No description available. ,
ReplacementKey: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: Trigger criterion value. ,
Required: False ,
}
string ,
}
,
]
,
parameters:
{
Description: Client input parameters to run Solution ,
Required: False ,
}
object ,
solutionId:
{
Description: Solution Id to identify single solution. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Status of solution provisioning. ,
Enum:
{
Succeeded: All Solutions in the Batch succeeded. ,
PartialComplete: Some Solutions are still running or failed. ,
Failed: All Solutions failed to run. ,
Running: All Solutions are still running. ,
Canceled: When Solutions request gets canceled. ,
}
,
Required: False ,
}
enum ,
title:
{
Description: The title. ,
Required: False ,
}
string ,
content:
{
Description: The HTML content that needs to be rendered and shown to customer. ,
Required: False ,
}
string ,
replacementMaps:
{
Description: Solution replacement maps. ,
Required: False ,
}
{
webResults:
{
Description: Solution AzureKB results ,
Required: False ,
}
[
{
replacementKey:
{
Description: Place holder used in HTML Content replace control with the content ,
Required: False ,
}
string ,
searchResults:
{
Description: AzureKB search results ,
Required: False ,
}
[
{
solutionId:
{
Description: Unique id of the result. ,
Required: False ,
}
string ,
content:
{
Description: Content of the search result. ,
Required: False ,
}
string ,
title:
{
Description: Title of the search result. ,
Required: False ,
}
string ,
confidence:
{
Description: Confidence of the search result. ,
Enum:
{
Low: No description available. ,
Medium: No description available. ,
High: No description available. ,
}
,
Required: False ,
}
enum ,
source:
{
Description: Source of the search result. ,
Required: False ,
}
string ,
resultType:
{
Description: Result type of the search result. ,
Enum:
{
Community: No description available. ,
Documentation: No description available. ,
}
,
Required: False ,
}
enum ,
rank:
{
Description: rank of the search result ,
Format: int32 ,
Required: False ,
}
integer ,
link:
{
Description: Link to the document. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
diagnostics:
{
Description: Solution diagnostics results. ,
Required: False ,
}
[
{
solutionId:
{
Description: Solution Id to identify single Solutions Diagnostic ,
Required: False ,
}
string ,
status:
{
Description: The status of the resource. ,
Enum:
{
Failed: No description available. ,
MissingInputs: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: Details of the status ,
Required: False ,
}
string ,
replacementKey:
{
Description: Place holder used in HTML Content replace control with the content ,
Required: False ,
}
string ,
requiredParameters:
{
Description: Required parameters of this item ,
Required: False ,
}
[
string ,
]
,
insights:
{
Description: Diagnostic insights ,
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 ,
}
,
]
,
}
,
]
,
troubleshooters:
{
Description: Solutions Troubleshooters ,
Required: False ,
}
[
{
solutionId:
{
Description: Solution Id to identify single Solutions Troubleshooter ,
Required: False ,
}
string ,
title:
{
Description: Troubleshooter title ,
Required: False ,
}
string ,
summary:
{
Description: Troubleshooter summary ,
Required: False ,
}
string ,
}
,
]
,
metricsBasedCharts:
{
Description: Solution metrics based charts ,
Required: False ,
}
[
{
name:
{
Description: Chart name ,
Required: False ,
}
string ,
aggregationType:
{
Description: Allowed values are Sum, Avg, Count, Min, Max. Default is Sum ,
Enum:
{
Sum: No description available. ,
Avg: No description available. ,
Count: No description available. ,
Min: No description available. ,
Max: No description available. ,
}
,
Required: False ,
}
enum ,
timeSpanDuration:
{
Description: Time span duration ,
Required: False ,
}
string ,
title:
{
Description: Chart title ,
Required: False ,
}
string ,
filterGroup:
{
Description: Filter group ,
Required: False ,
}
{
filter:
{
Description: List of filters ,
Required: False ,
}
[
{
name:
{
Description: Filter name ,
Required: False ,
}
string ,
values:
{
Description: Filter values ,
Required: False ,
}
string ,
operator:
{
Description: Filter operator ,
Required: False ,
}
string ,
}
,
]
,
}
,
replacementKey:
{
Description: Place holder used in HTML Content replace control with the content ,
Required: False ,
}
string ,
}
,
]
,
videos:
{
Description: Video solutions, which have the power to engage the customer by stimulating their senses ,
Required: False ,
}
[
{
replacementKey:
{
Description: Place holder used in HTML Content replace control with the insight content ,
Required: False ,
}
string ,
}
,
]
,
videoGroups:
{
Description: Group of Videos ,
Required: False ,
}
[
{
videos:
{
Description: List of videos will be shown to customers ,
Required: False ,
}
[
{
src:
{
Description: Link to the video ,
Required: False ,
}
string ,
title:
{
Description: Title of the video ,
Required: False ,
}
string ,
}
,
]
,
replacementKey:
{
Description: Place holder used in HTML Content replace control with the insight content ,
Required: False ,
}
string ,
}
,
]
,
}
,
sections:
{
Description: List of section object. ,
Required: False ,
}
[
{
title:
{
Description: Solution sections title. ,
Required: False ,
}
string ,
content:
{
Description: Solution sections content. ,
Required: False ,
}
string ,
replacementMaps:
{
Description: Solution replacement maps. ,
Required: False ,
}
{
webResults:
{
Description: Solution AzureKB results ,
Required: False ,
}
[
{
replacementKey:
{
Description: Place holder used in HTML Content replace control with the content ,
Required: False ,
}
string ,
searchResults:
{
Description: AzureKB search results ,
Required: False ,
}
[
{
solutionId:
{
Description: Unique id of the result. ,
Required: False ,
}
string ,
content:
{
Description: Content of the search result. ,
Required: False ,
}
string ,
title:
{
Description: Title of the search result. ,
Required: False ,
}
string ,
confidence:
{
Description: Confidence of the search result. ,
Enum:
{
Low: No description available. ,
Medium: No description available. ,
High: No description available. ,
}
,
Required: False ,
}
enum ,
source:
{
Description: Source of the search result. ,
Required: False ,
}
string ,
resultType:
{
Description: Result type of the search result. ,
Enum:
{
Community: No description available. ,
Documentation: No description available. ,
}
,
Required: False ,
}
enum ,
rank:
{
Description: rank of the search result ,
Format: int32 ,
Required: False ,
}
integer ,
link:
{
Description: Link to the document. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
diagnostics:
{
Description: Solution diagnostics results. ,
Required: False ,
}
[
{
solutionId:
{
Description: Solution Id to identify single Solutions Diagnostic ,
Required: False ,
}
string ,
status:
{
Description: The status of the resource. ,
Enum:
{
Failed: No description available. ,
MissingInputs: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: Details of the status ,
Required: False ,
}
string ,
replacementKey:
{
Description: Place holder used in HTML Content replace control with the content ,
Required: False ,
}
string ,
requiredParameters:
{
Description: Required parameters of this item ,
Required: False ,
}
[
string ,
]
,
insights:
{
Description: Diagnostic insights ,
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 ,
}
,
]
,
}
,
]
,
troubleshooters:
{
Description: Solutions Troubleshooters ,
Required: False ,
}
[
{
solutionId:
{
Description: Solution Id to identify single Solutions Troubleshooter ,
Required: False ,
}
string ,
title:
{
Description: Troubleshooter title ,
Required: False ,
}
string ,
summary:
{
Description: Troubleshooter summary ,
Required: False ,
}
string ,
}
,
]
,
metricsBasedCharts:
{
Description: Solution metrics based charts ,
Required: False ,
}
[
{
name:
{
Description: Chart name ,
Required: False ,
}
string ,
aggregationType:
{
Description: Allowed values are Sum, Avg, Count, Min, Max. Default is Sum ,
Enum:
{
Sum: No description available. ,
Avg: No description available. ,
Count: No description available. ,
Min: No description available. ,
Max: No description available. ,
}
,
Required: False ,
}
enum ,
timeSpanDuration:
{
Description: Time span duration ,
Required: False ,
}
string ,
title:
{
Description: Chart title ,
Required: False ,
}
string ,
filterGroup:
{
Description: Filter group ,
Required: False ,
}
{
filter:
{
Description: List of filters ,
Required: False ,
}
[
{
name:
{
Description: Filter name ,
Required: False ,
}
string ,
values:
{
Description: Filter values ,
Required: False ,
}
string ,
operator:
{
Description: Filter operator ,
Required: False ,
}
string ,
}
,
]
,
}
,
replacementKey:
{
Description: Place holder used in HTML Content replace control with the content ,
Required: False ,
}
string ,
}
,
]
,
videos:
{
Description: Video solutions, which have the power to engage the customer by stimulating their senses ,
Required: False ,
}
[
{
replacementKey:
{
Description: Place holder used in HTML Content replace control with the insight content ,
Required: False ,
}
string ,
}
,
]
,
videoGroups:
{
Description: Group of Videos ,
Required: False ,
}
[
{
videos:
{
Description: List of videos will be shown to customers ,
Required: False ,
}
[
{
src:
{
Description: Link to the video ,
Required: False ,
}
string ,
title:
{
Description: Title of the video ,
Required: False ,
}
string ,
}
,
]
,
replacementKey:
{
Description: Place holder used in HTML Content replace control with the insight content ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
$headers:
{
location: string ,
}
,
$schema:
{
Description: Solution response. ,
}
{
properties:
{
Description: Solution result ,
Required: False ,
}
{
triggerCriteria:
{
Description: Solution request trigger criteria ,
Required: False ,
}
[
{
name:
{
Description: Trigger criterion name. ,
Enum:
{
SolutionId: No description available. ,
ProblemClassificationId: No description available. ,
ReplacementKey: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: Trigger criterion value. ,
Required: False ,
}
string ,
}
,
]
,
parameters:
{
Description: Client input parameters to run Solution ,
Required: False ,
}
object ,
solutionId:
{
Description: Solution Id to identify single solution. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Status of solution provisioning. ,
Enum:
{
Succeeded: All Solutions in the Batch succeeded. ,
PartialComplete: Some Solutions are still running or failed. ,
Failed: All Solutions failed to run. ,
Running: All Solutions are still running. ,
Canceled: When Solutions request gets canceled. ,
}
,
Required: False ,
}
enum ,
title:
{
Description: The title. ,
Required: False ,
}
string ,
content:
{
Description: The HTML content that needs to be rendered and shown to customer. ,
Required: False ,
}
string ,
replacementMaps:
{
Description: Solution replacement maps. ,
Required: False ,
}
{
webResults:
{
Description: Solution AzureKB results ,
Required: False ,
}
[
{
replacementKey:
{
Description: Place holder used in HTML Content replace control with the content ,
Required: False ,
}
string ,
searchResults:
{
Description: AzureKB search results ,
Required: False ,
}
[
{
solutionId:
{
Description: Unique id of the result. ,
Required: False ,
}
string ,
content:
{
Description: Content of the search result. ,
Required: False ,
}
string ,
title:
{
Description: Title of the search result. ,
Required: False ,
}
string ,
confidence:
{
Description: Confidence of the search result. ,
Enum:
{
Low: No description available. ,
Medium: No description available. ,
High: No description available. ,
}
,
Required: False ,
}
enum ,
source:
{
Description: Source of the search result. ,
Required: False ,
}
string ,
resultType:
{
Description: Result type of the search result. ,
Enum:
{
Community: No description available. ,
Documentation: No description available. ,
}
,
Required: False ,
}
enum ,
rank:
{
Description: rank of the search result ,
Format: int32 ,
Required: False ,
}
integer ,
link:
{
Description: Link to the document. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
diagnostics:
{
Description: Solution diagnostics results. ,
Required: False ,
}
[
{
solutionId:
{
Description: Solution Id to identify single Solutions Diagnostic ,
Required: False ,
}
string ,
status:
{
Description: The status of the resource. ,
Enum:
{
Failed: No description available. ,
MissingInputs: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: Details of the status ,
Required: False ,
}
string ,
replacementKey:
{
Description: Place holder used in HTML Content replace control with the content ,
Required: False ,
}
string ,
requiredParameters:
{
Description: Required parameters of this item ,
Required: False ,
}
[
string ,
]
,
insights:
{
Description: Diagnostic insights ,
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 ,
}
,
]
,
}
,
]
,
troubleshooters:
{
Description: Solutions Troubleshooters ,
Required: False ,
}
[
{
solutionId:
{
Description: Solution Id to identify single Solutions Troubleshooter ,
Required: False ,
}
string ,
title:
{
Description: Troubleshooter title ,
Required: False ,
}
string ,
summary:
{
Description: Troubleshooter summary ,
Required: False ,
}
string ,
}
,
]
,
metricsBasedCharts:
{
Description: Solution metrics based charts ,
Required: False ,
}
[
{
name:
{
Description: Chart name ,
Required: False ,
}
string ,
aggregationType:
{
Description: Allowed values are Sum, Avg, Count, Min, Max. Default is Sum ,
Enum:
{
Sum: No description available. ,
Avg: No description available. ,
Count: No description available. ,
Min: No description available. ,
Max: No description available. ,
}
,
Required: False ,
}
enum ,
timeSpanDuration:
{
Description: Time span duration ,
Required: False ,
}
string ,
title:
{
Description: Chart title ,
Required: False ,
}
string ,
filterGroup:
{
Description: Filter group ,
Required: False ,
}
{
filter:
{
Description: List of filters ,
Required: False ,
}
[
{
name:
{
Description: Filter name ,
Required: False ,
}
string ,
values:
{
Description: Filter values ,
Required: False ,
}
string ,
operator:
{
Description: Filter operator ,
Required: False ,
}
string ,
}
,
]
,
}
,
replacementKey:
{
Description: Place holder used in HTML Content replace control with the content ,
Required: False ,
}
string ,
}
,
]
,
videos:
{
Description: Video solutions, which have the power to engage the customer by stimulating their senses ,
Required: False ,
}
[
{
replacementKey:
{
Description: Place holder used in HTML Content replace control with the insight content ,
Required: False ,
}
string ,
}
,
]
,
videoGroups:
{
Description: Group of Videos ,
Required: False ,
}
[
{
videos:
{
Description: List of videos will be shown to customers ,
Required: False ,
}
[
{
src:
{
Description: Link to the video ,
Required: False ,
}
string ,
title:
{
Description: Title of the video ,
Required: False ,
}
string ,
}
,
]
,
replacementKey:
{
Description: Place holder used in HTML Content replace control with the insight content ,
Required: False ,
}
string ,
}
,
]
,
}
,
sections:
{
Description: List of section object. ,
Required: False ,
}
[
{
title:
{
Description: Solution sections title. ,
Required: False ,
}
string ,
content:
{
Description: Solution sections content. ,
Required: False ,
}
string ,
replacementMaps:
{
Description: Solution replacement maps. ,
Required: False ,
}
{
webResults:
{
Description: Solution AzureKB results ,
Required: False ,
}
[
{
replacementKey:
{
Description: Place holder used in HTML Content replace control with the content ,
Required: False ,
}
string ,
searchResults:
{
Description: AzureKB search results ,
Required: False ,
}
[
{
solutionId:
{
Description: Unique id of the result. ,
Required: False ,
}
string ,
content:
{
Description: Content of the search result. ,
Required: False ,
}
string ,
title:
{
Description: Title of the search result. ,
Required: False ,
}
string ,
confidence:
{
Description: Confidence of the search result. ,
Enum:
{
Low: No description available. ,
Medium: No description available. ,
High: No description available. ,
}
,
Required: False ,
}
enum ,
source:
{
Description: Source of the search result. ,
Required: False ,
}
string ,
resultType:
{
Description: Result type of the search result. ,
Enum:
{
Community: No description available. ,
Documentation: No description available. ,
}
,
Required: False ,
}
enum ,
rank:
{
Description: rank of the search result ,
Format: int32 ,
Required: False ,
}
integer ,
link:
{
Description: Link to the document. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
diagnostics:
{
Description: Solution diagnostics results. ,
Required: False ,
}
[
{
solutionId:
{
Description: Solution Id to identify single Solutions Diagnostic ,
Required: False ,
}
string ,
status:
{
Description: The status of the resource. ,
Enum:
{
Failed: No description available. ,
MissingInputs: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: Details of the status ,
Required: False ,
}
string ,
replacementKey:
{
Description: Place holder used in HTML Content replace control with the content ,
Required: False ,
}
string ,
requiredParameters:
{
Description: Required parameters of this item ,
Required: False ,
}
[
string ,
]
,
insights:
{
Description: Diagnostic insights ,
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 ,
}
,
]
,
}
,
]
,
troubleshooters:
{
Description: Solutions Troubleshooters ,
Required: False ,
}
[
{
solutionId:
{
Description: Solution Id to identify single Solutions Troubleshooter ,
Required: False ,
}
string ,
title:
{
Description: Troubleshooter title ,
Required: False ,
}
string ,
summary:
{
Description: Troubleshooter summary ,
Required: False ,
}
string ,
}
,
]
,
metricsBasedCharts:
{
Description: Solution metrics based charts ,
Required: False ,
}
[
{
name:
{
Description: Chart name ,
Required: False ,
}
string ,
aggregationType:
{
Description: Allowed values are Sum, Avg, Count, Min, Max. Default is Sum ,
Enum:
{
Sum: No description available. ,
Avg: No description available. ,
Count: No description available. ,
Min: No description available. ,
Max: No description available. ,
}
,
Required: False ,
}
enum ,
timeSpanDuration:
{
Description: Time span duration ,
Required: False ,
}
string ,
title:
{
Description: Chart title ,
Required: False ,
}
string ,
filterGroup:
{
Description: Filter group ,
Required: False ,
}
{
filter:
{
Description: List of filters ,
Required: False ,
}
[
{
name:
{
Description: Filter name ,
Required: False ,
}
string ,
values:
{
Description: Filter values ,
Required: False ,
}
string ,
operator:
{
Description: Filter operator ,
Required: False ,
}
string ,
}
,
]
,
}
,
replacementKey:
{
Description: Place holder used in HTML Content replace control with the content ,
Required: False ,
}
string ,
}
,
]
,
videos:
{
Description: Video solutions, which have the power to engage the customer by stimulating their senses ,
Required: False ,
}
[
{
replacementKey:
{
Description: Place holder used in HTML Content replace control with the insight content ,
Required: False ,
}
string ,
}
,
]
,
videoGroups:
{
Description: Group of Videos ,
Required: False ,
}
[
{
videos:
{
Description: List of videos will be shown to customers ,
Required: False ,
}
[
{
src:
{
Description: Link to the video ,
Required: False ,
}
string ,
title:
{
Description: Title of the video ,
Required: False ,
}
string ,
}
,
]
,
replacementKey:
{
Description: Place holder used in HTML Content replace control with the insight content ,
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 ,
}
,
]
,
}
,
}
Troubleshooters_Create (removed)
Description :  Creates the specific troubleshooter action under a resource or subscription using the ‘solutionId’ and ‘properties.parameters’ as the trigger.
Azure Troubleshooters help with hard to classify issues, reducing the gap between customer observed problems and solutions by guiding the user effortlessly through the troubleshooting process. Each Troubleshooter flow represents a problem area within Azure and has a complex tree-like structure that addresses many root causes. These flows are prepared with the help of Subject Matter experts and customer support engineers by carefully considering previous support requests raised by customers. Troubleshooters terminate at a well curated solution based off of resource backend signals and customer manual selections.
Reference :  Link ¶

⚼ Request

PUT:  /{scope}/providers/Microsoft.Help/troubleshooters/{troubleshooterName}
{
scope:
{
Description: scope = resourceUri of affected resource.
For example: /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read ,
Required: True ,
}
string ,
troubleshooterName:
{
Description: Troubleshooter resource Name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
createTroubleshooterRequestBody:
{
Description: The required request body for this Troubleshooter resource creation. ,
Required: False ,
}
{
properties:
{
Description: Troubleshooter Instance properties. ,
Required: False ,
}
{
solutionId:
{
Description: Solution Id to identify single troubleshooter. ,
Required: False ,
}
string ,
parameters:
{
Description: Client input parameters to run Troubleshooter Resource ,
Required: False ,
}
object ,
provisioningState:
{
Description: Status of troubleshooter provisioning. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Running: No description available. ,
AutoContinue: No description available. ,
}
,
Required: False ,
}
enum ,
steps:
{
Description: List of step object. ,
Required: False ,
}
[
{
id:
{
Description: Unique step id. ,
Required: False ,
}
string ,
title:
{
Description: Step title. ,
Required: False ,
}
string ,
description:
{
Description: Step description. ,
Required: False ,
}
string ,
guidance:
{
Description: Get or sets the Step guidance. ,
Required: False ,
}
string ,
executionStatus:
{
Description: Status of Troubleshooter Step execution. ,
Enum:
{
Success: Step execution succeeded. ,
Running: Step execution running ,
Failed: Step execution failed ,
Warning: Step execution warning ,
}
,
Required: False ,
}
enum ,
executionStatusDescription:
{
Description: This field has more detailed status description of the execution status. ,
Required: False ,
}
string ,
type:
{
Description: Type of Troubleshooting step. ,
Enum:
{
Decision: No description available. ,
Solution: No description available. ,
Insight: No description available. ,
AutomatedCheck: No description available. ,
}
,
Required: False ,
}
enum ,
isLastStep:
{
Description: is this last step of the workflow. ,
Required: False ,
}
boolean ,
inputs:
{
Required: False ,
}
[
{
questionId:
{
Description: Use Index as QuestionId. ,
Required: False ,
}
string ,
questionType:
{
Description: Type of Question ,
Enum:
{
RadioButton: SingleChoice radio button ,
Dropdown: SingleChoice dropdown. ,
TextInput: Text Input ,
MultiLineInfoBox: MultiLineInfoBox ,
}
,
Required: False ,
}
enum ,
questionContent:
{
Description: User question content. ,
Required: False ,
}
string ,
questionContentType:
{
Description: Default is Text. ,
Enum:
{
Text: No description available. ,
Html: No description available. ,
Markdown: No description available. ,
}
,
Required: False ,
}
enum ,
responseHint:
{
Description: Place holder text for response hints. ,
Required: False ,
}
string ,
recommendedOption:
{
Description: Result of Automate step. ,
Required: False ,
}
string ,
selectedOptionValue:
{
Description: Text of response that was selected. ,
Required: False ,
}
string ,
responseValidationProperties:
{
Description: Troubleshooter step input response validation properties ,
Required: False ,
}
{
regex:
{
Description: Regex used for the input validation. ,
Required: False ,
}
string ,
isRequired:
{
Description: Default True ,
Required: False ,
}
boolean ,
validationErrorMessage:
{
Description: Validation Error Message. ,
Required: False ,
}
string ,
maxLength:
{
Description: Max text input (open Ended Text). ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
responseOptions:
{
Required: False ,
}
[
{
key:
{
Description: Unique string. ,
Required: False ,
}
string ,
value:
{
Description: Option description ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
automatedCheckResults:
{
Description: Only for AutomatedStep type ,
Required: False ,
}
{
result:
{
Description: Insight Article Content ,
Required: False ,
}
string ,
type:
{
Description: Type of Result. ,
Enum:
{
Success: No description available. ,
Warning: No description available. ,
Error: No description available. ,
Information: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
insights:
{
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: The error detail. ,
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 ,
}
,
]
,
}
,
}
,
]
,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Troubleshooter Instance properties. ,
Required: False ,
}
{
solutionId:
{
Description: Solution Id to identify single troubleshooter. ,
Required: False ,
}
string ,
parameters:
{
Description: Client input parameters to run Troubleshooter Resource ,
Required: False ,
}
object ,
provisioningState:
{
Description: Status of troubleshooter provisioning. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Running: No description available. ,
AutoContinue: No description available. ,
}
,
Required: False ,
}
enum ,
steps:
{
Description: List of step object. ,
Required: False ,
}
[
{
id:
{
Description: Unique step id. ,
Required: False ,
}
string ,
title:
{
Description: Step title. ,
Required: False ,
}
string ,
description:
{
Description: Step description. ,
Required: False ,
}
string ,
guidance:
{
Description: Get or sets the Step guidance. ,
Required: False ,
}
string ,
executionStatus:
{
Description: Status of Troubleshooter Step execution. ,
Enum:
{
Success: Step execution succeeded. ,
Running: Step execution running ,
Failed: Step execution failed ,
Warning: Step execution warning ,
}
,
Required: False ,
}
enum ,
executionStatusDescription:
{
Description: This field has more detailed status description of the execution status. ,
Required: False ,
}
string ,
type:
{
Description: Type of Troubleshooting step. ,
Enum:
{
Decision: No description available. ,
Solution: No description available. ,
Insight: No description available. ,
AutomatedCheck: No description available. ,
}
,
Required: False ,
}
enum ,
isLastStep:
{
Description: is this last step of the workflow. ,
Required: False ,
}
boolean ,
inputs:
{
Required: False ,
}
[
{
questionId:
{
Description: Use Index as QuestionId. ,
Required: False ,
}
string ,
questionType:
{
Description: Type of Question ,
Enum:
{
RadioButton: SingleChoice radio button ,
Dropdown: SingleChoice dropdown. ,
TextInput: Text Input ,
MultiLineInfoBox: MultiLineInfoBox ,
}
,
Required: False ,
}
enum ,
questionContent:
{
Description: User question content. ,
Required: False ,
}
string ,
questionContentType:
{
Description: Default is Text. ,
Enum:
{
Text: No description available. ,
Html: No description available. ,
Markdown: No description available. ,
}
,
Required: False ,
}
enum ,
responseHint:
{
Description: Place holder text for response hints. ,
Required: False ,
}
string ,
recommendedOption:
{
Description: Result of Automate step. ,
Required: False ,
}
string ,
selectedOptionValue:
{
Description: Text of response that was selected. ,
Required: False ,
}
string ,
responseValidationProperties:
{
Description: Troubleshooter step input response validation properties ,
Required: False ,
}
{
regex:
{
Description: Regex used for the input validation. ,
Required: False ,
}
string ,
isRequired:
{
Description: Default True ,
Required: False ,
}
boolean ,
validationErrorMessage:
{
Description: Validation Error Message. ,
Required: False ,
}
string ,
maxLength:
{
Description: Max text input (open Ended Text). ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
responseOptions:
{
Required: False ,
}
[
{
key:
{
Description: Unique string. ,
Required: False ,
}
string ,
value:
{
Description: Option description ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
automatedCheckResults:
{
Description: Only for AutomatedStep type ,
Required: False ,
}
{
result:
{
Description: Insight Article Content ,
Required: False ,
}
string ,
type:
{
Description: Type of Result. ,
Enum:
{
Success: No description available. ,
Warning: No description available. ,
Error: No description available. ,
Information: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
insights:
{
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: The error detail. ,
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 ,
}
,
]
,
}
,
}
,
]
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Troubleshooter Instance properties. ,
Required: False ,
}
{
solutionId:
{
Description: Solution Id to identify single troubleshooter. ,
Required: False ,
}
string ,
parameters:
{
Description: Client input parameters to run Troubleshooter Resource ,
Required: False ,
}
object ,
provisioningState:
{
Description: Status of troubleshooter provisioning. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Running: No description available. ,
AutoContinue: No description available. ,
}
,
Required: False ,
}
enum ,
steps:
{
Description: List of step object. ,
Required: False ,
}
[
{
id:
{
Description: Unique step id. ,
Required: False ,
}
string ,
title:
{
Description: Step title. ,
Required: False ,
}
string ,
description:
{
Description: Step description. ,
Required: False ,
}
string ,
guidance:
{
Description: Get or sets the Step guidance. ,
Required: False ,
}
string ,
executionStatus:
{
Description: Status of Troubleshooter Step execution. ,
Enum:
{
Success: Step execution succeeded. ,
Running: Step execution running ,
Failed: Step execution failed ,
Warning: Step execution warning ,
}
,
Required: False ,
}
enum ,
executionStatusDescription:
{
Description: This field has more detailed status description of the execution status. ,
Required: False ,
}
string ,
type:
{
Description: Type of Troubleshooting step. ,
Enum:
{
Decision: No description available. ,
Solution: No description available. ,
Insight: No description available. ,
AutomatedCheck: No description available. ,
}
,
Required: False ,
}
enum ,
isLastStep:
{
Description: is this last step of the workflow. ,
Required: False ,
}
boolean ,
inputs:
{
Required: False ,
}
[
{
questionId:
{
Description: Use Index as QuestionId. ,
Required: False ,
}
string ,
questionType:
{
Description: Type of Question ,
Enum:
{
RadioButton: SingleChoice radio button ,
Dropdown: SingleChoice dropdown. ,
TextInput: Text Input ,
MultiLineInfoBox: MultiLineInfoBox ,
}
,
Required: False ,
}
enum ,
questionContent:
{
Description: User question content. ,
Required: False ,
}
string ,
questionContentType:
{
Description: Default is Text. ,
Enum:
{
Text: No description available. ,
Html: No description available. ,
Markdown: No description available. ,
}
,
Required: False ,
}
enum ,
responseHint:
{
Description: Place holder text for response hints. ,
Required: False ,
}
string ,
recommendedOption:
{
Description: Result of Automate step. ,
Required: False ,
}
string ,
selectedOptionValue:
{
Description: Text of response that was selected. ,
Required: False ,
}
string ,
responseValidationProperties:
{
Description: Troubleshooter step input response validation properties ,
Required: False ,
}
{
regex:
{
Description: Regex used for the input validation. ,
Required: False ,
}
string ,
isRequired:
{
Description: Default True ,
Required: False ,
}
boolean ,
validationErrorMessage:
{
Description: Validation Error Message. ,
Required: False ,
}
string ,
maxLength:
{
Description: Max text input (open Ended Text). ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
responseOptions:
{
Required: False ,
}
[
{
key:
{
Description: Unique string. ,
Required: False ,
}
string ,
value:
{
Description: Option description ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
automatedCheckResults:
{
Description: Only for AutomatedStep type ,
Required: False ,
}
{
result:
{
Description: Insight Article Content ,
Required: False ,
}
string ,
type:
{
Description: Type of Result. ,
Enum:
{
Success: No description available. ,
Warning: No description available. ,
Error: No description available. ,
Information: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
insights:
{
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: The error detail. ,
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 ,
}
,
]
,
}
,
}
,
]
,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
Troubleshooters_Get (removed)
Description :  Gets troubleshooter instance result which includes the step status/result of the troubleshooter resource name that is being executed.
Get API is used to retrieve the result of a Troubleshooter instance, which includes the status and result of each step in the Troubleshooter workflow. This API requires the Troubleshooter resource name that was created using the Create API.
Reference :  Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.Help/troubleshooters/{troubleshooterName}
{
scope:
{
Description: scope = resourceUri of affected resource.
For example: /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read ,
Required: True ,
}
string ,
troubleshooterName:
{
Description: Troubleshooter resource Name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Troubleshooter Instance properties. ,
Required: False ,
}
{
solutionId:
{
Description: Solution Id to identify single troubleshooter. ,
Required: False ,
}
string ,
parameters:
{
Description: Client input parameters to run Troubleshooter Resource ,
Required: False ,
}
object ,
provisioningState:
{
Description: Status of troubleshooter provisioning. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Running: No description available. ,
AutoContinue: No description available. ,
}
,
Required: False ,
}
enum ,
steps:
{
Description: List of step object. ,
Required: False ,
}
[
{
id:
{
Description: Unique step id. ,
Required: False ,
}
string ,
title:
{
Description: Step title. ,
Required: False ,
}
string ,
description:
{
Description: Step description. ,
Required: False ,
}
string ,
guidance:
{
Description: Get or sets the Step guidance. ,
Required: False ,
}
string ,
executionStatus:
{
Description: Status of Troubleshooter Step execution. ,
Enum:
{
Success: Step execution succeeded. ,
Running: Step execution running ,
Failed: Step execution failed ,
Warning: Step execution warning ,
}
,
Required: False ,
}
enum ,
executionStatusDescription:
{
Description: This field has more detailed status description of the execution status. ,
Required: False ,
}
string ,
type:
{
Description: Type of Troubleshooting step. ,
Enum:
{
Decision: No description available. ,
Solution: No description available. ,
Insight: No description available. ,
AutomatedCheck: No description available. ,
}
,
Required: False ,
}
enum ,
isLastStep:
{
Description: is this last step of the workflow. ,
Required: False ,
}
boolean ,
inputs:
{
Required: False ,
}
[
{
questionId:
{
Description: Use Index as QuestionId. ,
Required: False ,
}
string ,
questionType:
{
Description: Type of Question ,
Enum:
{
RadioButton: SingleChoice radio button ,
Dropdown: SingleChoice dropdown. ,
TextInput: Text Input ,
MultiLineInfoBox: MultiLineInfoBox ,
}
,
Required: False ,
}
enum ,
questionContent:
{
Description: User question content. ,
Required: False ,
}
string ,
questionContentType:
{
Description: Default is Text. ,
Enum:
{
Text: No description available. ,
Html: No description available. ,
Markdown: No description available. ,
}
,
Required: False ,
}
enum ,
responseHint:
{
Description: Place holder text for response hints. ,
Required: False ,
}
string ,
recommendedOption:
{
Description: Result of Automate step. ,
Required: False ,
}
string ,
selectedOptionValue:
{
Description: Text of response that was selected. ,
Required: False ,
}
string ,
responseValidationProperties:
{
Description: Troubleshooter step input response validation properties ,
Required: False ,
}
{
regex:
{
Description: Regex used for the input validation. ,
Required: False ,
}
string ,
isRequired:
{
Description: Default True ,
Required: False ,
}
boolean ,
validationErrorMessage:
{
Description: Validation Error Message. ,
Required: False ,
}
string ,
maxLength:
{
Description: Max text input (open Ended Text). ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
responseOptions:
{
Required: False ,
}
[
{
key:
{
Description: Unique string. ,
Required: False ,
}
string ,
value:
{
Description: Option description ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
automatedCheckResults:
{
Description: Only for AutomatedStep type ,
Required: False ,
}
{
result:
{
Description: Insight Article Content ,
Required: False ,
}
string ,
type:
{
Description: Type of Result. ,
Enum:
{
Success: No description available. ,
Warning: No description available. ,
Error: No description available. ,
Information: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
insights:
{
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: The error detail. ,
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 ,
}
,
]
,
}
,
}
,
]
,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
Troubleshooters_Continue (removed)
Description :  Uses ‘stepId’ and ‘responses’ as the trigger to continue the troubleshooting steps for the respective troubleshooter resource name.
Continue API is used to provide inputs that are required for the specific troubleshooter to progress into the next step in the process. This API is used after the Troubleshooter has been created using the Create API.
Reference :  Link ¶

⚼ Request

POST:  /{scope}/providers/Microsoft.Help/troubleshooters/{troubleshooterName}/continue
{
scope:
{
Description: scope = resourceUri of affected resource.
For example: /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read ,
Required: True ,
}
string ,
troubleshooterName:
{
Description: Troubleshooter resource Name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
continueRequestBody:
{
Description: The required request body for going to next step in Troubleshooter resource. ,
Required: False ,
}
{
stepId:
{
Description: Unique id of the result. ,
Required: False ,
}
string ,
responses:
{
Required: False ,
}
[
{
questionId:
{
Description: id of the question. ,
Required: False ,
}
string ,
questionType:
{
Description: Type of Question ,
Enum:
{
RadioButton: SingleChoice radio button ,
Dropdown: SingleChoice dropdown. ,
TextInput: Text Input ,
MultiLineInfoBox: MultiLineInfoBox ,
}
,
Required: False ,
}
enum ,
response:
{
Description: Response key for SingleInput. For Multi-line test/open ended question it is free form text ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (204)

{
location: 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 ,
}
,
]
,
}
,
}
Troubleshooters_End (removed)
Description :  Ends the troubleshooter action
Reference :  Link ¶

⚼ Request

POST:  /{scope}/providers/Microsoft.Help/troubleshooters/{troubleshooterName}/end
{
scope:
{
Description: scope = resourceUri of affected resource.
For example: /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read ,
Required: True ,
}
string ,
troubleshooterName:
{
Description: Troubleshooter resource Name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{
location: 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 ,
}
,
]
,
}
,
}
Troubleshooters_Restart (removed)
Description :  Restarts the troubleshooter API using applicable troubleshooter resource name as the input.
It returns new resource name which should be used in subsequent request. The old resource name is obsolete after this API is invoked.
Reference :  Link ¶

⚼ Request

POST:  /{scope}/providers/Microsoft.Help/troubleshooters/{troubleshooterName}/restart
{
scope:
{
Description: scope = resourceUri of affected resource.
For example: /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read ,
Required: True ,
}
string ,
troubleshooterName:
{
Description: Troubleshooter resource Name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
location: string ,
}
,
$schema:
{
Description: Troubleshooter restart response ,
}
{
troubleshooterResourceName:
{
Description: Updated TroubleshooterResource Name . ,
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 ,
}
,
]
,
}
,
}