regulatory_compliance_controls
Creates, updates, deletes, gets or lists a regulatory_compliance_controls resource.
Overview
| Name | regulatory_compliance_controls |
| Type | Resource |
| Id | azure.security.regulatory_compliance_controls |
Fields
The following fields are returned by SELECT queries:
- get
- 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. |
description | string | The description of the regulatory compliance control. |
failedAssessments | integer | The number of supported regulatory compliance assessments of the given control with a failed state. |
passedAssessments | integer | The number of supported regulatory compliance assessments of the given control with a passed state. |
skippedAssessments | integer | The number of supported regulatory compliance assessments of the given control with a skipped state. |
state | string | Aggregative state based on the control's supported assessments 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". |
| 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. |
description | string | The description of the regulatory compliance control. |
failedAssessments | integer | The number of supported regulatory compliance assessments of the given control with a failed state. |
passedAssessments | integer | The number of supported regulatory compliance assessments of the given control with a passed state. |
skippedAssessments | integer | The number of supported regulatory compliance assessments of the given control with a skipped state. |
state | string | Aggregative state based on the control's supported assessments 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". |
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, subscription_id | Selected regulatory compliance control details and state. | |
list | select | regulatory_compliance_standard_name, subscription_id | $filter | All supported regulatory compliance controls details and state for selected standard. |
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_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
- list
Selected regulatory compliance control details and state.
SELECT
id,
name,
description,
failedAssessments,
passedAssessments,
skippedAssessments,
state,
systemData,
type
FROM azure.security.regulatory_compliance_controls
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
;
All supported regulatory compliance controls details and state for selected standard.
SELECT
id,
name,
description,
failedAssessments,
passedAssessments,
skippedAssessments,
state,
systemData,
type
FROM azure.security.regulatory_compliance_controls
WHERE regulatory_compliance_standard_name = '{{ regulatory_compliance_standard_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
;