secure_score_controls
Creates, updates, deletes, gets or lists a secure_score_controls resource.
Overview
| Name | secure_score_controls |
| Type | Resource |
| Id | azure.security.secure_score_controls |
Fields
The following fields are returned by SELECT queries:
- list_by_secure_score
- 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. |
definition | object | Information about the security control. |
displayName | string | User friendly display name of the control. |
healthyResourceCount | integer | Number of healthy resources in the control. |
notApplicableResourceCount | integer | Number of not applicable resources in the control. |
score | object | Actual score object for the control. |
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". |
unhealthyResourceCount | integer | Number of unhealthy resources in the control. |
weight | integer | The relative weight for this specific control in each of your subscriptions. Used when calculating an aggregated score for this control across all of your subscriptions. |
| 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. |
definition | object | Information about the security control. |
displayName | string | User friendly display name of the control. |
healthyResourceCount | integer | Number of healthy resources in the control. |
notApplicableResourceCount | integer | Number of not applicable resources in the control. |
score | object | Actual score object for the control. |
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". |
unhealthyResourceCount | integer | Number of unhealthy resources in the control. |
weight | integer | The relative weight for this specific control in each of your subscriptions. Used when calculating an aggregated score for this control across all of your subscriptions. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list_by_secure_score | select | secure_score_name, subscription_id | $expand | Get all security controls for a specific initiative within a scope. |
list | select | subscription_id | $expand | Get all security controls within a 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 |
|---|---|---|
secure_score_name | string | The initiative name. For the ASC Default initiative, use 'ascScore' as in the sample request below. Required. |
subscription_id | string | |
$expand | string | OData expand. Optional. "definition" Default value is None. |
SELECT examples
- list_by_secure_score
- list
Get all security controls for a specific initiative within a scope.
SELECT
id,
name,
definition,
displayName,
healthyResourceCount,
notApplicableResourceCount,
score,
systemData,
type,
unhealthyResourceCount,
weight
FROM azure.security.secure_score_controls
WHERE secure_score_name = '{{ secure_score_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $expand = '{{ $expand }}'
;
Get all security controls within a scope.
SELECT
id,
name,
definition,
displayName,
healthyResourceCount,
notApplicableResourceCount,
score,
systemData,
type,
unhealthyResourceCount,
weight
FROM azure.security.secure_score_controls
WHERE subscription_id = '{{ subscription_id }}' -- required
AND $expand = '{{ $expand }}'
;