sub_assessments

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

Overview

Name	sub_assessments
Type	Resource
Id	azure.security.sub_assessments

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.
additionalData	object	Details of the sub-assessment.
category	string	Category of the sub-assessment.
description	string	Human readable description of the assessment status.
displayName	string	User friendly display name of the sub-assessment.
impact	string	Description of the impact of this sub-assessment.
remediation	string	Information on how to remediate this sub-assessment.
resourceDetails	object	Details of the resource that was assessed.
status	object	Status of the sub-assessment.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
timeGenerated	string (date-time)	The date and time the sub-assessment was generated.
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.
additionalData	object	Details of the sub-assessment.
category	string	Category of the sub-assessment.
description	string	Human readable description of the assessment status.
displayName	string	User friendly display name of the sub-assessment.
impact	string	Description of the impact of this sub-assessment.
remediation	string	Information on how to remediate this sub-assessment.
resourceDetails	object	Details of the resource that was assessed.
status	object	Status of the sub-assessment.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
timeGenerated	string (date-time)	The date and time the sub-assessment was generated.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_all

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.
additionalData	object	Details of the sub-assessment.
category	string	Category of the sub-assessment.
description	string	Human readable description of the assessment status.
displayName	string	User friendly display name of the sub-assessment.
impact	string	Description of the impact of this sub-assessment.
remediation	string	Information on how to remediate this sub-assessment.
resourceDetails	object	Details of the resource that was assessed.
status	object	Status of the sub-assessment.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
timeGenerated	string (date-time)	The date and time the sub-assessment was generated.
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, assessment_name, sub_assessment_name		Get a security sub-assessment on your scanned resource.
list	select	scope, assessment_name		Get security sub-assessments on all your scanned resources inside a scope.
list_all	select	scope		Get security sub-assessments on all your scanned resources inside a subscription scope.

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
assessment_name	string	The security assessment key - unique key for the assessment type. Required.
scope	string	The fully qualified Azure Resource manager identifier of the resource. Required.
sub_assessment_name	string	The Sub-Assessment Key - Unique key for the sub-assessment type. Required.

SELECT examples

get

Get a security sub-assessment on your scanned resource.

SELECT
id,
name,
additionalData,
category,
description,
displayName,
impact,
remediation,
resourceDetails,
status,
systemData,
timeGenerated,
type
FROM azure.security.sub_assessments
WHERE scope = '{{ scope }}' -- required
AND assessment_name = '{{ assessment_name }}' -- required
AND sub_assessment_name = '{{ sub_assessment_name }}' -- required
;

list

Get security sub-assessments on all your scanned resources inside a scope.

SELECT
id,
name,
additionalData,
category,
description,
displayName,
impact,
remediation,
resourceDetails,
status,
systemData,
timeGenerated,
type
FROM azure.security.sub_assessments
WHERE scope = '{{ scope }}' -- required
AND assessment_name = '{{ assessment_name }}' -- required
;

list_all

Get security sub-assessments on all your scanned resources inside a subscription scope.

SELECT
id,
name,
additionalData,
category,
description,
displayName,
impact,
remediation,
resourceDetails,
status,
systemData,
timeGenerated,
type
FROM azure.security.sub_assessments
WHERE scope = '{{ scope }}' -- required
;