Assessments Metadata - Create In Subscription

Create metadata information on an assessment type in a specific subscription

PUT https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Security/assessmentMetadata/{assessmentMetadataName}?api-version=2020-01-01

URI Parameters

Name In Required Type Description
assessmentMetadataName
path True
  • string

The Assessment Key - Unique key for the assessment type

subscriptionId
path True
  • string

Azure subscription ID

Regex pattern: ^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$

api-version
query True
  • string

API version for the operation

Request Body

Name Required Type Description
properties.assessmentType True

BuiltIn if the assessment based on built-in Azure Policy definition, Custom if the assessment based on custom Azure Policy definition

properties.displayName True
  • string

User friendly display name of the assessment

properties.severity True

The severity level of the assessment

properties.categories
  • string[]

The categories of resource that is at risk when the assessment is unhealthy

properties.description
  • string

Human readable description of the assessment

properties.implementationEffort

The implementation effort required to remediate this assessment

properties.partnerData

Describes the partner that created the assessment

properties.preview
  • boolean

True if this assessment is in preview release status

properties.remediationDescription
  • string

Human readable description of what you should do to mitigate this security issue

properties.threats
  • string[]

Threats impact of the assessment

properties.userImpact

The user impact of the assessment

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

Create security assessment metadata for subscription

Sample Request

PUT https://management.azure.com/subscriptions/0980887d-03d6-408c-9566-532f3456804e/providers/Microsoft.Security/assessmentMetadata/ca039e75-a276-4175-aebc-bcd41e4b14b7?api-version=2020-01-01

{
  "properties": {
    "displayName": "Install endpoint protection solution on virtual machine scale sets",
    "description": "Install an endpoint protection solution on your virtual machines scale sets, to protect them from threats and vulnerabilities.",
    "remediationDescription": "To install an endpoint protection solution: 1.  <a href=\"https://docs.microsoft.com/azure/virtual-machine-scale-sets/virtual-machine-scale-sets-faq#how-do-i-turn-on-antimalware-in-my-virtual-machine-scale-set\">Follow the instructions in How do I turn on antimalware in my virtual machine scale set</a>",
    "categories": [
      "Compute"
    ],
    "severity": "Medium",
    "userImpact": "Low",
    "implementationEffort": "Low",
    "threats": [
      "dataExfiltration",
      "dataSpillage",
      "maliciousInsider"
    ],
    "assessmentType": "CustomerManaged"
  }
}

Sample Response

{
  "id": "/providers/Microsoft.Security/assessmentMetadata/ca039e75-a276-4175-aebc-bcd41e4b14b7",
  "name": "ca039e75-a276-4175-aebc-bcd41e4b14b7",
  "type": "Microsoft.Security/assessmentMetadata",
  "properties": {
    "displayName": "My organization security assessment",
    "description": "Assessment that my organization created to view our security assessment in Azure Security Center",
    "remediationDescription": "Fix it with these remediation instructions",
    "categories": [
      "Compute"
    ],
    "severity": "Medium",
    "userImpact": "Low",
    "implementationEffort": "Low",
    "threats": [
      "dataExfiltration",
      "dataSpillage",
      "maliciousInsider"
    ],
    "assessmentType": "CustomerManaged"
  }
}

Definitions

assessmentType

BuiltIn if the assessment based on built-in Azure Policy definition, Custom if the assessment based on custom Azure Policy definition

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.).

CloudErrorBody

The error detail.

ErrorAdditionalInfo

The resource management error additional info.

implementationEffort

The implementation effort required to remediate this assessment

SecurityAssessmentMetadata

Security assessment metadata

SecurityAssessmentMetadataPartnerData

Describes the partner that created the assessment

severity

The severity level of the assessment

userImpact

The user impact of the assessment

assessmentType

BuiltIn if the assessment based on built-in Azure Policy definition, Custom if the assessment based on custom Azure Policy definition

Name Type Description
BuiltIn
  • string

Microsoft Defender for Cloud managed assessments

CustomPolicy
  • string

User defined policies that are automatically ingested from Azure Policy to Microsoft Defender for Cloud

CustomerManaged
  • string

User assessments pushed directly by the user or other third party to Microsoft Defender for Cloud

VerifiedPartner
  • string

An assessment that was created by a verified 3rd party if the user connected it to ASC

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.

ErrorAdditionalInfo

The resource management error additional info.

Name Type Description
info
  • object

The additional info.

type
  • string

The additional info type.

implementationEffort

The implementation effort required to remediate this assessment

Name Type Description
High
  • string
Low
  • string
Moderate
  • string

SecurityAssessmentMetadata

Security assessment metadata

Name Type Description
id
  • string

Resource Id

name
  • string

Resource name

properties.assessmentType

BuiltIn if the assessment based on built-in Azure Policy definition, Custom if the assessment based on custom Azure Policy definition

properties.categories
  • string[]

The categories of resource that is at risk when the assessment is unhealthy

properties.description
  • string

Human readable description of the assessment

properties.displayName
  • string

User friendly display name of the assessment

properties.implementationEffort

The implementation effort required to remediate this assessment

properties.partnerData

Describes the partner that created the assessment

properties.policyDefinitionId
  • string

Azure resource ID of the policy definition that turns this assessment calculation on

properties.preview
  • boolean

True if this assessment is in preview release status

properties.remediationDescription
  • string

Human readable description of what you should do to mitigate this security issue

properties.severity

The severity level of the assessment

properties.threats
  • string[]

Threats impact of the assessment

properties.userImpact

The user impact of the assessment

type
  • string

Resource type

SecurityAssessmentMetadataPartnerData

Describes the partner that created the assessment

Name Type Description
partnerName
  • string

Name of the company of the partner

productName
  • string

Name of the product of the partner that created the assessment

secret
  • string

Secret to authenticate the partner and verify it created the assessment - write only

severity

The severity level of the assessment

Name Type Description
High
  • string
Low
  • string
Medium
  • string

userImpact

The user impact of the assessment

Name Type Description
High
  • string
Low
  • string
Moderate
  • string