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 (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties	object	Describes properties of an sub-assessment.
systemData	object	Metadata pertaining to creation and last modification of the resource.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

list

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties	object	Describes properties of an sub-assessment.
systemData	object	Metadata pertaining to creation and last modification of the resource.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

list_all

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties	object	Describes properties of an sub-assessment.
systemData	object	Metadata pertaining to creation and last modification of the resource.
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, assessmentName, subAssessmentName	api-version	Get a security sub-assessment on your scanned resource
list	select	scope, assessmentName	api-version	Get security sub-assessments on all your scanned resources inside a scope
list_all	select	scope	api-version	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
assessmentName	string	The Assessment Key - Unique key for the assessment type
scope	string	The scope of the standard assignment. Valid scopes are: management group (format: 'providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: 'subscriptions/{subscriptionId}'), or security connector (format: 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName})'
subAssessmentName	string	The Sub-Assessment Key - Unique key for the sub-assessment type
api-version	string	API version for the operation

SELECT examples

get

Get a security sub-assessment on your scanned resource

SELECT
id,
name,
properties,
systemData,
type
FROM azure.security.sub_assessments
WHERE scope = '{{ scope }}' -- required
AND assessmentName = '{{ assessmentName }}' -- required
AND subAssessmentName = '{{ subAssessmentName }}' -- required
AND api-version = '{{ api-version }}'
;

list

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

SELECT
id,
name,
properties,
systemData,
type
FROM azure.security.sub_assessments
WHERE scope = '{{ scope }}' -- required
AND assessmentName = '{{ assessmentName }}' -- required
AND api-version = '{{ api-version }}'
;

list_all

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

SELECT
id,
name,
properties,
systemData,
type
FROM azure.security.sub_assessments
WHERE scope = '{{ scope }}' -- required
AND api-version = '{{ api-version }}'
;