troubleshooters
Creates, updates, deletes, gets or lists a troubleshooters resource.
Overview
| Name | troubleshooters |
| Type | Resource |
| Id | azure_extras.help.troubleshooters |
Fields
- vw_troubleshooters
- troubleshooters
| Name | Datatype | Description |
|---|---|---|
parameters | text | field from the properties object |
provisioning_state | text | field from the properties object |
scope | text | field from the properties object |
solution_id | text | field from the properties object |
steps | text | field from the properties object |
troubleshooterName | text | field from the properties object |
| Name | Datatype | Description |
|---|---|---|
properties | object | Troubleshooter Instance properties. |
Methods
| Name | Accessible by | Required Params | Description |
|---|---|---|---|
get | SELECT | scope, troubleshooterName | 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. |
create | INSERT | scope, troubleshooterName | 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. |
continue | EXEC | scope, troubleshooterName | 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. |
end | EXEC | scope, troubleshooterName | Ends the troubleshooter action |
restart | EXEC | scope, troubleshooterName | 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. |
SELECT examples
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.
- vw_troubleshooters
- troubleshooters
SELECT
parameters,
provisioning_state,
scope,
solution_id,
steps,
troubleshooterName
FROM azure_extras.help.vw_troubleshooters
WHERE scope = '{{ scope }}'
AND troubleshooterName = '{{ troubleshooterName }}';
SELECT
properties
FROM azure_extras.help.troubleshooters
WHERE scope = '{{ scope }}'
AND troubleshooterName = '{{ troubleshooterName }}';
INSERT example
Use the following StackQL query and manifest file to create a new troubleshooters resource.
- All Properties
- Manifest
/*+ create */
INSERT INTO azure_extras.help.troubleshooters (
scope,
troubleshooterName,
properties
)
SELECT
'{{ scope }}',
'{{ troubleshooterName }}',
'{{ properties }}'
;
- name: your_resource_model_name
props:
- name: properties
value:
- name: solutionId
value: string
- name: parameters
value: object
- name: provisioningState
value: string
- name: steps
value:
- - name: id
value: string
- name: title
value: string
- name: description
value: string
- name: guidance
value: string
- name: executionStatus
value: string
- name: executionStatusDescription
value: string
- name: type
value: string
- name: isLastStep
value: boolean
- name: inputs
value:
- - name: questionId
value: string
- name: questionType
value: []
- name: questionTitle
value: string
- name: questionContent
value: string
- name: questionContentType
value: string
- name: responseHint
value: string
- name: recommendedOption
value: string
- name: selectedOptionValue
value: string
- name: responseValidationProperties
value:
- name: regex
value: string
- name: validationScope
value: string
- name: isRequired
value: boolean
- name: validationErrorMessage
value: string
- name: maxLength
value: integer
- name: responseOptions
value:
- - name: key
value: string
- name: value
value: string
- name: automatedCheckResults
value:
- name: version
value: string
- name: status
value: string
- name: result
value: string
- name: type
value: string
- name: insights
value:
- - name: id
value: string
- name: title
value: string
- name: results
value: string
- name: importanceLevel
value: string
- name: error
value:
- name: code
value: string
- name: message
value: string
- name: target
value: string
- name: details
value:
- - name: code
value: string
- name: message
value: string
- name: target
value: string
- name: details
value:
- - name: code
value: string
- name: message
value: string
- name: target
value: string
- name: details
value:
- - name: code
value: string
- name: message
value: string
- name: target
value: string
- name: details
value:
- - name: code
value: string
- name: message
value: string
- name: target
value: string
- name: details
value:
- - name: code
value: string
- name: message
value: string
- name: target
value: string
- name: details
value:
- - name: code
value: string
- name: message
value: string
- name: target
value: string
- name: details
value:
- - name: code
value: string
- name: message
value: string
- name: target
value: string
- name: details
value:
- []
- name: additionalInfo
value:
- []
- name: additionalInfo
value:
- - name: type
value: string
- name: info
value: object
- name: additionalInfo
value:
- - name: type
value: string
- name: info
value: object
- name: additionalInfo
value:
- - name: type
value: string
- name: info
value: object
- name: additionalInfo
value:
- - name: type
value: string
- name: info
value: object
- name: additionalInfo
value:
- - name: type
value: string
- name: info
value: object
- name: additionalInfo
value:
- - name: type
value: string
- name: info
value: object
- name: additionalInfo
value:
- - name: type
value: string
- name: info
value: object