Class: Azure::Security::Mgmt::V2019_01_01_preview::Models::SecurityAssessmentMetadata

Inherits:
Resource
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2019-01-01-preview/generated/azure_mgmt_security/models/security_assessment_metadata.rb

Overview

Security assessment metadata

Instance Attribute Summary collapse

Attributes inherited from Resource

#id, #name, #type

Class Method Summary collapse

Methods inherited from Resource

#resource_group

Instance Attribute Details

#assessment_type ⇒ AssessmentType

Azure Policy definition, Custom if the assessment based on custom Azure Policy definition. Possible values include: ‘BuiltIn’, ‘CustomPolicy’, ‘CustomerManaged’

Returns:



55
56
57
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security/models/security_assessment_metadata.rb', line 55

def assessment_type
  @assessment_type
end

#category ⇒ Array<Category>

Returns:



30
31
32
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security/models/security_assessment_metadata.rb', line 30

def category
  @category
end

#description ⇒ String

Returns Human readable description of the assessment.

Returns:

  • (String) —

    Human readable description of the assessment



23
24
25
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security/models/security_assessment_metadata.rb', line 23

def description
  @description
end

#display_name ⇒ String

Returns User friendly display name of the assessment.

Returns:

  • (String) —

    User friendly display name of the assessment



16
17
18
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security/models/security_assessment_metadata.rb', line 16

def display_name
  @display_name
end

#implementation_effort ⇒ ImplementationEffort

remediate this assessment. Possible values include: ‘Low’, ‘Moderate’, ‘High’

Returns:



43
44
45
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security/models/security_assessment_metadata.rb', line 43

def implementation_effort
  @implementation_effort
end

#policy_definition_id ⇒ String

this assessment calculation on

Returns:

  • (String) —

    Azure resource ID of the policy definition that turns



20
21
22
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security/models/security_assessment_metadata.rb', line 20

def policy_definition_id
  @policy_definition_id
end

#preview ⇒ Boolean

Returns True if this assessment is in preview release status.

Returns:

  • (Boolean) —

    True if this assessment is in preview release status



49
50
51
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security/models/security_assessment_metadata.rb', line 49

def preview
  @preview
end

#remediation_description ⇒ String

mitigate this security issue

Returns:

  • (String) —

    Human readable description of what you should do to



27
28
29
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security/models/security_assessment_metadata.rb', line 27

def remediation_description
  @remediation_description
end

#severity ⇒ Severity

values include: ‘Low’, ‘Medium’, ‘High’

Returns:

  • (Severity) —

    The severity level of the assessment. Possible



34
35
36
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security/models/security_assessment_metadata.rb', line 34

def severity
  @severity
end

#threats ⇒ Array<Threats>

Returns:



46
47
48
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security/models/security_assessment_metadata.rb', line 46

def threats
  @threats
end

#user_impact ⇒ UserImpact

include: ‘Low’, ‘Moderate’, ‘High’

Returns:

  • (UserImpact) —

    The user impact of the assessment. Possible values



38
39
40
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security/models/security_assessment_metadata.rb', line 38

def user_impact
  @user_impact
end

Class Method Details

.mapper ⇒ Object

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



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security/models/security_assessment_metadata.rb', line 62

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'SecurityAssessmentMetadata',
    type: {
      name: 'Composite',
      class_name: 'SecurityAssessmentMetadata',
      model_properties: {
        id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'id',
          type: {
            name: 'String'
          }
        },
        name: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'name',
          type: {
            name: 'String'
          }
        },
        type: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'type',
          type: {
            name: 'String'
          }
        },
        display_name: {
          client_side_validation: true,
          required: true,
          serialized_name: 'properties.displayName',
          type: {
            name: 'String'
          }
        },
        policy_definition_id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.policyDefinitionId',
          type: {
            name: 'String'
          }
        },
        description: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.description',
          type: {
            name: 'String'
          }
        },
        remediation_description: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.remediationDescription',
          type: {
            name: 'String'
          }
        },
        category: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.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: 'properties.severity',
          type: {
            name: 'String'
          }
        },
        user_impact: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.userImpact',
          type: {
            name: 'String'
          }
        },
        implementation_effort: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.implementationEffort',
          type: {
            name: 'String'
          }
        },
        threats: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.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: 'properties.preview',
          type: {
            name: 'Boolean'
          }
        },
        assessment_type: {
          client_side_validation: true,
          required: true,
          serialized_name: 'properties.assessmentType',
          type: {
            name: 'String'
          }
        }
      }
    }
  }
end