diagnostics
Creates, updates, deletes, gets or lists a diagnostics
resource.
Overview
Name | diagnostics |
Type | Resource |
Id | azure_extras.help.diagnostics |
Fields
The following fields are returned by SELECT
queries:
- get
Successful fetched insight diagnostic (may contain errors).
Name | Datatype | Description |
---|---|---|
properties | object | Diagnostic Resource properties. |
Methods
The following methods are available for this resource:
Name | Accessible by | Required Params | Optional Params | Description |
---|---|---|---|---|
get | select | scope , diagnosticsResourceName | Get the diagnostics using the 'diagnosticsResourceName' you chose while creating the diagnostic. | |
create | insert | scope , diagnosticsResourceName | Creates a diagnostic for the specific resource using solutionId 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. |
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 |
---|---|---|
diagnosticsResourceName | string | Unique resource name for insight resources |
scope | string | The scope at which the operation is performed. |
SELECT
examples
- get
Get the diagnostics using the 'diagnosticsResourceName' you chose while creating the diagnostic.
SELECT
properties
FROM azure_extras.help.diagnostics
WHERE scope = '{{ scope }}' -- required
AND diagnosticsResourceName = '{{ diagnosticsResourceName }}' -- required
;
INSERT
examples
- create
- Manifest
Creates a diagnostic for the specific resource using solutionId 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.
INSERT INTO azure_extras.help.diagnostics (
data__properties,
scope,
diagnosticsResourceName
)
SELECT
'{{ properties }}',
'{{ scope }}',
'{{ diagnosticsResourceName }}'
RETURNING
properties
;
# Description fields are for documentation purposes
- name: diagnostics
props:
- name: scope
value: string
description: Required parameter for the diagnostics resource.
- name: diagnosticsResourceName
value: string
description: Required parameter for the diagnostics resource.
- name: properties
value: object
description: |
Diagnostic Resource properties.