class Azure::Security::Mgmt::V2020_01_01::Models::SecurityAssessmentMetadataProperties

Describes properties of an assessment metadata.

Attributes

assessment_type[RW]

@return [AssessmentType] BuiltIn if the assessment based on built-in Azure Policy definition, Custom if the assessment based on custom Azure Policy definition. Possible values include: 'BuiltIn', 'CustomPolicy', 'CustomerManaged', 'VerifiedPartner'

category[RW]

@return [Array<Category>]

description[RW]

@return [String] Human readable description of the assessment

display_name[RW]

@return [String] User friendly display name of the assessment

implementation_effort[RW]

@return [ImplementationEffort] The implementation effort required to remediate this assessment. Possible values include: 'Low', 'Moderate', 'High'

partner_data[RW]

@return [SecurityAssessmentMetadataPartnerData]

policy_definition_id[RW]

@return [String] Azure resource ID of the policy definition that turns this assessment calculation on

preview[RW]

@return [Boolean] True if this assessment is in preview release status

remediation_description[RW]

@return [String] Human readable description of what you should do to mitigate this security issue

severity[RW]

@return [Severity] The severity level of the assessment. Possible values include: 'Low', 'Medium', 'High'

threats[RW]

@return [Array<Threats>]

user_impact[RW]

@return [UserImpact] The user impact of the assessment. Possible values include: 'Low', 'Moderate', 'High'

Private Class Methods

mapper() click to toggle source

Mapper for SecurityAssessmentMetadataProperties class as Ruby Hash. This will be used for serialization/deserialization.

# File lib/2020-01-01/generated/azure_mgmt_security/models/security_assessment_metadata_properties.rb, line 65
def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'SecurityAssessmentMetadataProperties',
    type: {
      name: 'Composite',
      class_name: 'SecurityAssessmentMetadataProperties',
      model_properties: {
        display_name: {
          client_side_validation: true,
          required: true,
          serialized_name: 'displayName',
          type: {
            name: 'String'
          }
        },
        policy_definition_id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'policyDefinitionId',
          type: {
            name: 'String'
          }
        },
        description: {
          client_side_validation: true,
          required: false,
          serialized_name: 'description',
          type: {
            name: 'String'
          }
        },
        remediation_description: {
          client_side_validation: true,
          required: false,
          serialized_name: 'remediationDescription',
          type: {
            name: 'String'
          }
        },
        category: {
          client_side_validation: true,
          required: false,
          serialized_name: 'category',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'CategoryElementType',
                type: {
                  name: 'String'
                }
            }
          }
        },
        severity: {
          client_side_validation: true,
          required: true,
          serialized_name: 'severity',
          type: {
            name: 'String'
          }
        },
        user_impact: {
          client_side_validation: true,
          required: false,
          serialized_name: 'userImpact',
          type: {
            name: 'String'
          }
        },
        implementation_effort: {
          client_side_validation: true,
          required: false,
          serialized_name: 'implementationEffort',
          type: {
            name: 'String'
          }
        },
        threats: {
          client_side_validation: true,
          required: false,
          serialized_name: 'threats',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'ThreatsElementType',
                type: {
                  name: 'String'
                }
            }
          }
        },
        preview: {
          client_side_validation: true,
          required: false,
          serialized_name: 'preview',
          type: {
            name: 'Boolean'
          }
        },
        assessment_type: {
          client_side_validation: true,
          required: true,
          serialized_name: 'assessmentType',
          type: {
            name: 'String'
          }
        },
        partner_data: {
          client_side_validation: true,
          required: false,
          serialized_name: 'partnerData',
          type: {
            name: 'Composite',
            class_name: 'SecurityAssessmentMetadataPartnerData'
          }
        }
      }
    }
  }
end