regulatory_compliance_assessments

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

Overview

Name	regulatory_compliance_assessments
Type	Resource
Id	azure.security.regulatory_compliance_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.
assessmentDetailsLink	string	Link to more detailed assessment results data. The response type will be according to the assessmentType field.
assessmentType	string	The expected type of assessment contained in the AssessmentDetailsLink.
description	string	The description of the regulatory compliance assessment.
failedResources	integer	The given assessment's related resources count with failed state.
passedResources	integer	The given assessment's related resources count with passed state.
skippedResources	integer	The given assessment's related resources count with skipped state.
state	string	Aggregative state based on the assessment's scanned resources states. Known values are: "Passed", "Failed", "Skipped", "Unsupported", "On", and "Off". (Passed, Failed, Skipped, Unsupported, On, Off)
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".
unsupportedResources	integer	The given assessment's related resources count with unsupported state.

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.
assessmentDetailsLink	string	Link to more detailed assessment results data. The response type will be according to the assessmentType field.
assessmentType	string	The expected type of assessment contained in the AssessmentDetailsLink.
description	string	The description of the regulatory compliance assessment.
failedResources	integer	The given assessment's related resources count with failed state.
passedResources	integer	The given assessment's related resources count with passed state.
skippedResources	integer	The given assessment's related resources count with skipped state.
state	string	Aggregative state based on the assessment's scanned resources states. Known values are: "Passed", "Failed", "Skipped", "Unsupported", "On", and "Off". (Passed, Failed, Skipped, Unsupported, On, Off)
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".
unsupportedResources	integer	The given assessment's related resources count with unsupported state.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	regulatory_compliance_standard_name, regulatory_compliance_control_name, regulatory_compliance_assessment_name, subscription_id		Supported regulatory compliance details and state for selected assessment.
list	select	regulatory_compliance_standard_name, regulatory_compliance_control_name, subscription_id	$filter	Details and state of assessments mapped to selected regulatory compliance control.

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
regulatory_compliance_assessment_name	string	Name of the regulatory compliance assessment object. Required.
regulatory_compliance_control_name	string	Name of the regulatory compliance control object. Required.
regulatory_compliance_standard_name	string	Name of the regulatory compliance standard object. Required.
subscription_id	string
$filter	string	OData filter. Optional. Default value is None.

SELECT examples

get

Supported regulatory compliance details and state for selected assessment.

SELECT
id,
name,
assessmentDetailsLink,
assessmentType,
description,
failedResources,
passedResources,
skippedResources,
state,
systemData,
type,
unsupportedResources
FROM azure.security.regulatory_compliance_assessments
WHERE regulatory_compliance_standard_name = '{{ regulatory_compliance_standard_name }}' -- required
AND regulatory_compliance_control_name = '{{ regulatory_compliance_control_name }}' -- required
AND regulatory_compliance_assessment_name = '{{ regulatory_compliance_assessment_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Details and state of assessments mapped to selected regulatory compliance control.

SELECT
id,
name,
assessmentDetailsLink,
assessmentType,
description,
failedResources,
passedResources,
skippedResources,
state,
systemData,
type,
unsupportedResources
FROM azure.security.regulatory_compliance_assessments
WHERE regulatory_compliance_standard_name = '{{ regulatory_compliance_standard_name }}' -- required
AND regulatory_compliance_control_name = '{{ regulatory_compliance_control_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
;