SecurityAssessmentMetadataProperties interface

Describes properties of an assessment metadata.

Properties

assessmentType

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

categories
description

Human readable description of the assessment

displayName

User friendly display name of the assessment

implementationEffort

The implementation effort required to remediate this assessment

partnerData

Describes the partner that created the assessment

policyDefinitionId

Azure resource ID of the policy definition that turns this assessment calculation on NOTE: This property will not be serialized. It can only be populated by the server.

preview

True if this assessment is in preview release status

remediationDescription

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

severity

The severity level of the assessment

threats
userImpact

The user impact of the assessment

Property Details

assessmentType

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

assessmentType: string

Property Value

string

categories

categories?: string[]

Property Value

string[]

description

Human readable description of the assessment

description?: string

Property Value

string

displayName

User friendly display name of the assessment

displayName: string

Property Value

string

implementationEffort

The implementation effort required to remediate this assessment

implementationEffort?: string

Property Value

string

partnerData

Describes the partner that created the assessment

partnerData?: SecurityAssessmentMetadataPartnerData

Property Value

policyDefinitionId

Azure resource ID of the policy definition that turns this assessment calculation on NOTE: This property will not be serialized. It can only be populated by the server.

policyDefinitionId?: string

Property Value

string

preview

True if this assessment is in preview release status

preview?: boolean

Property Value

boolean

remediationDescription

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

remediationDescription?: string

Property Value

string

severity

The severity level of the assessment

severity: string

Property Value

string

threats

threats?: string[]

Property Value

string[]

userImpact

The user impact of the assessment

userImpact?: string

Property Value

string