insights

Creates, updates, deletes, gets or lists an insights resource.

Overview

Name	insights
Type	Resource
Id	azure.impact_reporting.insights

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
additionalDetails	object	additional details of the insight.
category	string	category of the insight. Required.
content	object	Contains title & description for the insight. Required.
eventId	string	Identifier of the event that has been correlated with this insight. This can be used to aggregate insights for the same event.
eventTime	string (date-time)	Time of the event, which has been correlated the impact.
groupId	string	Identifier that can be used to group similar insights.
impact	object	details of of the impact for which insight has been generated. Required.
insightUniqueId	string	unique id of the insight. Required.
provisioningState	string	Resource provisioning state. Known values are: "Succeeded", "Failed", and "Canceled". (Succeeded, Failed, Canceled)
status	string	status of the insight. example resolved, repaired, other.
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".

list_by_subscription

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
additionalDetails	object	additional details of the insight.
category	string	category of the insight. Required.
content	object	Contains title & description for the insight. Required.
eventId	string	Identifier of the event that has been correlated with this insight. This can be used to aggregate insights for the same event.
eventTime	string (date-time)	Time of the event, which has been correlated the impact.
groupId	string	Identifier that can be used to group similar insights.
impact	object	details of of the impact for which insight has been generated. Required.
insightUniqueId	string	unique id of the insight. Required.
provisioningState	string	Resource provisioning state. Known values are: "Succeeded", "Failed", and "Canceled". (Succeeded, Failed, Canceled)
status	string	status of the insight. example resolved, repaired, other.
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	workload_impact_name, insight_name, subscription_id		Get Insight resources by workloadImpactName and insightName.
list_by_subscription	select	workload_impact_name, subscription_id		List Insight resources by workloadImpactName.
create	insert	workload_impact_name, insight_name, subscription_id		Create Insight resource, This is Admin only operation.
delete	delete	workload_impact_name, insight_name, subscription_id		Delete Insight resource, This is Admin only operation.

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
insight_name	string	Name of the insight. Required.
subscription_id	string
workload_impact_name	string	workloadImpact resource. Required.

SELECT examples

get

Get Insight resources by workloadImpactName and insightName.

SELECT
id,
name,
additionalDetails,
category,
content,
eventId,
eventTime,
groupId,
impact,
insightUniqueId,
provisioningState,
status,
systemData,
type
FROM azure.impact_reporting.insights
WHERE workload_impact_name = '{{ workload_impact_name }}' -- required
AND insight_name = '{{ insight_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

List Insight resources by workloadImpactName.

SELECT
id,
name,
additionalDetails,
category,
content,
eventId,
eventTime,
groupId,
impact,
insightUniqueId,
provisioningState,
status,
systemData,
type
FROM azure.impact_reporting.insights
WHERE workload_impact_name = '{{ workload_impact_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Create Insight resource, This is Admin only operation.

INSERT INTO azure.impact_reporting.insights (
properties,
workload_impact_name,
insight_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ workload_impact_name }}',
'{{ insight_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: insights
props:
  - name: workload_impact_name
    value: "{{ workload_impact_name }}"
    description: Required parameter for the insights resource.
  - name: insight_name
    value: "{{ insight_name }}"
    description: Required parameter for the insights resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the insights resource.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      provisioningState: "{{ provisioningState }}"
      category: "{{ category }}"
      status: "{{ status }}"
      eventId: "{{ eventId }}"
      groupId: "{{ groupId }}"
      content:
        title: "{{ title }}"
        description: "{{ description }}"
      eventTime: "{{ eventTime }}"
      insightUniqueId: "{{ insightUniqueId }}"
      impact:
        impactedResourceId: "{{ impactedResourceId }}"
        startTime: "{{ startTime }}"
        endTime: "{{ endTime }}"
        impactId: "{{ impactId }}"
      additionalDetails: "{{ additionalDetails }}"

DELETE examples

delete

Delete Insight resource, This is Admin only operation.

DELETE FROM azure.impact_reporting.insights
WHERE workload_impact_name = '{{ workload_impact_name }}' --required
AND insight_name = '{{ insight_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;