solution

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

Overview

Name	solution
Type	Resource
Id	azure_extras.self_help.solution

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.
content	string	The HTML content that needs to be rendered and shown to customer.
parameters	object	Client input parameters to run Solution.
provisioningState	string	Status of solution provisioning. Known values are: "Succeeded", "PartialComplete", "Failed", "Running", and "Canceled".
replacementMaps	object	Solution replacement maps.
sections	array	List of section object.
solutionId	string	Solution Id to identify single solution.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
title	string	The title.
triggerCriteria	array	Solution request trigger criteria.
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, solution_resource_name		Get the solution using the applicable solutionResourceName while creating the solution.
create	insert	scope, solution_resource_name		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. (3.) Thoughtfully assembled textual troubleshooting instructions. All these components are seamlessly converged into unified solutions tailored to address a specific support problem area.
update	update	scope, solution_resource_name		Update the requiredInputs or additional information needed to execute the solution.
warm_up	exec	scope, solution_resource_name		Warm up the solution resource by preloading asynchronous diagnostics results into cache.

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.
solution_resource_name	string	Solution resource Name. Required.

SELECT examples

get

Get the solution using the applicable solutionResourceName while creating the solution.

SELECT
id,
name,
content,
parameters,
provisioningState,
replacementMaps,
sections,
solutionId,
systemData,
title,
triggerCriteria,
type
FROM azure_extras.self_help.solution
WHERE scope = '{{ scope }}' -- required
AND solution_resource_name = '{{ solution_resource_name }}' -- required
;

INSERT examples

create

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. (3.) Thoughtfully assembled textual troubleshooting instructions. All these components are seamlessly converged into unified solutions tailored to address a specific support problem area.

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

Manifest

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

UPDATE examples

update

Update the requiredInputs or additional information needed to execute the solution.

UPDATE azure_extras.self_help.solution
SET 
properties = '{{ properties }}'
WHERE 
scope = '{{ scope }}' --required
AND solution_resource_name = '{{ solution_resource_name }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

Lifecycle Methods

warm_up

Warm up the solution resource by preloading asynchronous diagnostics results into cache.

EXEC azure_extras.self_help.solution.warm_up 
@scope='{{ scope }}' --required, 
@solution_resource_name='{{ solution_resource_name }}' --required 
@@json=
'{
"parameters": "{{ parameters }}"
}'
;