troubleshooters

Creates, updates, deletes, gets or lists a troubleshooters resource.

Overview

Name	troubleshooters
Type	Resource
Id	azure_extras.self_help.troubleshooters

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}". # pylint: disable=line-too-long
name	string	The name of the resource.
parameters	object	Client input parameters to run Troubleshooter Resource.
provisioningState	string	Status of troubleshooter provisioning. Known values are: "Succeeded", "Failed", "Canceled", "Running", and "AutoContinue".
solutionId	string	Solution Id to identify single troubleshooter.
steps	array	List of step object.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	scope, troubleshooter_name		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, troubleshooter_name		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_method	exec	scope, troubleshooter_name		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, troubleshooter_name		Ends the troubleshooter action.
restart	exec	scope, troubleshooter_name		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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
scope	string	scope = resourceUri of affected resource. For example: /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read. Required.
troubleshooter_name	string	Troubleshooter resource Name. Required.

SELECT examples

get

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.

SELECT
id,
name,
parameters,
provisioningState,
solutionId,
steps,
systemData,
type
FROM azure_extras.self_help.troubleshooters
WHERE scope = '{{ scope }}' -- required
AND troubleshooter_name = '{{ troubleshooter_name }}' -- required
;

INSERT examples

create

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.

INSERT INTO azure_extras.self_help.troubleshooters (
properties,
scope,
troubleshooter_name
)
SELECT 
'{{ properties }}',
'{{ scope }}',
'{{ troubleshooter_name }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: troubleshooters
props:
  - name: scope
    value: "{{ scope }}"
    description: Required parameter for the troubleshooters resource.
  - name: troubleshooter_name
    value: "{{ troubleshooter_name }}"
    description: Required parameter for the troubleshooters resource.
  - name: properties
    value:
      solutionId: "{{ solutionId }}"
      parameters: "{{ parameters }}"

Lifecycle Methods

continue_method

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.

EXEC azure_extras.self_help.troubleshooters.continue_method 
@scope='{{ scope }}' --required, 
@troubleshooter_name='{{ troubleshooter_name }}' --required 
@@json=
'{
"stepId": "{{ stepId }}", 
"responses": "{{ responses }}"
}'
;

end

Ends the troubleshooter action.

EXEC azure_extras.self_help.troubleshooters.end 
@scope='{{ scope }}' --required, 
@troubleshooter_name='{{ troubleshooter_name }}' --required
;

restart

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.

EXEC azure_extras.self_help.troubleshooters.restart 
@scope='{{ scope }}' --required, 
@troubleshooter_name='{{ troubleshooter_name }}' --required
;