health_reports

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

Overview

Name	health_reports
Type	Resource
Id	azure.security.health_reports

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.
affectedDefendersPlans	array	The affected defenders plans by unhealthy report.
affectedDefendersSubPlans	array	The affected defenders sub plans by unhealthy report.
environmentDetails	object	The environment details of the resource.
healthDataClassification	object	The classification of the health report.
issues	array	A collection of the issues in the report.
reportAdditionalData	object	Additional data for the given health report, this field can include more details on the resource and the health scenario.
resourceDetails	object	The resource details of the health report.
status	object	The status of the health report.
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

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.
affectedDefendersPlans	array	The affected defenders plans by unhealthy report.
affectedDefendersSubPlans	array	The affected defenders sub plans by unhealthy report.
environmentDetails	object	The environment details of the resource.
healthDataClassification	object	The classification of the health report.
issues	array	A collection of the issues in the report.
reportAdditionalData	object	Additional data for the given health report, this field can include more details on the resource and the health scenario.
resourceDetails	object	The resource details of the health report.
status	object	The status of the health report.
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	resource_id, health_report_name		Get health report of resource.
list	select	scope		Get a list of all health reports inside a scope. Valid scopes are: subscription (format: 'subscriptions/{subscriptionId}'), or security connector (format: 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName})'.

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
health_report_name	string	The health report key. Required.
resource_id	string	The fully qualified Azure Resource manager identifier of the resource. Required.
scope	string	The fully qualified Azure Resource manager identifier of the resource. Required.

SELECT examples

get

Get health report of resource.

SELECT
id,
name,
affectedDefendersPlans,
affectedDefendersSubPlans,
environmentDetails,
healthDataClassification,
issues,
reportAdditionalData,
resourceDetails,
status,
systemData,
type
FROM azure.security.health_reports
WHERE resource_id = '{{ resource_id }}' -- required
AND health_report_name = '{{ health_report_name }}' -- required
;

list

Get a list of all health reports inside a scope. Valid scopes are: subscription (format: 'subscriptions/{subscriptionId}'), or security connector (format: 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName})'.

SELECT
id,
name,
affectedDefendersPlans,
affectedDefendersSubPlans,
environmentDetails,
healthDataClassification,
issues,
reportAdditionalData,
resourceDetails,
status,
systemData,
type
FROM azure.security.health_reports
WHERE scope = '{{ scope }}' -- required
;