Secure Score Control Definitions - List
List the available security controls, their assessments, and the max score
GET https://management.azure.com/providers/Microsoft.Security/secureScoreControlDefinitions?api-version=2020-01-01
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
api-version
|
query | True |
string |
API version for the operation |
Responses
Name | Type | Description |
---|---|---|
200 OK |
OK |
|
Other Status Codes |
Error response describing why the operation failed. |
Security
azure_auth
Azure Active Directory OAuth2 Flow
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | impersonate your user account |
Examples
List security controls definition
Sample request
GET https://management.azure.com/providers/Microsoft.Security/secureScoreControlDefinitions?api-version=2020-01-01
Sample response
{
"value": [
{
"id": "/providers/Microsoft.Security/SecureScoreControlDefinitions/a9909064-42b4-4d34-8143-275477afe18b",
"name": "a9909064-42b4-4d34-8143-275477afe18b",
"type": "Microsoft.Security/SecureScoreControlDefinitions",
"properties": {
"source": {
"sourceType": "BuiltIn"
},
"displayName": "Protect applications against DDoS attacks",
"description": "This control contains recommendations regarding DDoS attack prevention",
"maxScore": 2,
"assessmentDefinitions": [
{
"id": "/providers/Microsoft.Security/assessmentMetadata/e3de1cc0-f4dd-3b34-e496-8b5381ba2d70"
}
]
}
},
{
"id": "/providers/Microsoft.Security/SecureScoreControlDefinitions/a000c66f-6da2-4f9d-826d-2364347d2588",
"name": "a000c66f-6da2-4f9d-826d-2364347d2588",
"type": "Microsoft.Security/SecureScoreControlDefinitions",
"properties": {
"source": {
"sourceType": "BuiltIn"
},
"displayName": "Apply adaptive application control",
"description": "This control contains recommendations regarding enabling adaptive application control",
"maxScore": 3,
"assessmentDefinitions": [
{
"id": "/providers/Microsoft.Security/assessmentMetadata/35f45c95-27cf-4e52-891f-8390d1de5828"
},
{
"id": "/providers/Microsoft.Security/assessmentMetadata/d1db3318-01ff-16de-29eb-28b344515626"
},
{
"id": "/providers/Microsoft.Security/assessmentMetadata/e7ee30c4-bac9-2966-54bd-2023a4282872"
},
{
"id": "/providers/Microsoft.Security/assessmentMetadata/8e2b96ff-3de2-289b-b5c1-3b9921a3441e"
}
]
}
}
]
}
Definitions
Name | Description |
---|---|
Azure |
Describes an Azure resource with kind |
Cloud |
Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.). |
Cloud |
The error detail. |
control |
The type of security control (for example, BuiltIn) |
Error |
The resource management error additional info. |
Secure |
Information about the security control. |
secure |
List of security controls definition |
Secure |
The type of the security control (For example, BuiltIn) |
AzureResourceLink
Describes an Azure resource with kind
Name | Type | Description |
---|---|---|
id |
string |
Azure resource Id |
CloudError
Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).
Name | Type | Description |
---|---|---|
error.additionalInfo |
The error additional info. |
|
error.code |
string |
The error code. |
error.details |
The error details. |
|
error.message |
string |
The error message. |
error.target |
string |
The error target. |
CloudErrorBody
The error detail.
Name | Type | Description |
---|---|---|
additionalInfo |
The error additional info. |
|
code |
string |
The error code. |
details |
The error details. |
|
message |
string |
The error message. |
target |
string |
The error target. |
controlType
The type of security control (for example, BuiltIn)
Name | Type | Description |
---|---|---|
BuiltIn |
string |
Microsoft Defender for Cloud managed assessments |
Custom |
string |
Non Microsoft Defender for Cloud managed assessments |
ErrorAdditionalInfo
The resource management error additional info.
Name | Type | Description |
---|---|---|
info |
object |
The additional info. |
type |
string |
The additional info type. |
SecureScoreControlDefinitionItem
Information about the security control.
Name | Type | Description |
---|---|---|
id |
string |
Resource Id |
name |
string |
Resource name |
properties.assessmentDefinitions |
Array of assessments metadata IDs that are included in this security control |
|
properties.description |
string |
User friendly description of the control |
properties.displayName |
string |
User friendly display name of the control |
properties.maxScore |
integer |
Maximum control score (0..10) |
properties.source |
Source object from which the control was created |
|
type |
string |
Resource type |
secureScoreControlDefinitionList
List of security controls definition
Name | Type | Description |
---|---|---|
nextLink |
string |
The URI to fetch the next page. |
value |
Collection of security controls definition in this page |
SecureScoreControlDefinitionSource
The type of the security control (For example, BuiltIn)
Name | Type | Description |
---|---|---|
sourceType |
The type of security control (for example, BuiltIn) |