Class: Azure::PolicyInsights::Mgmt::V2019_10_01::Models::PolicyState

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2019-10-01/generated/azure_mgmt_policy_insights/models/policy_state.rb

Overview

Policy state record.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#additional_properties ⇒ Object

collection

Returns:

  • Unmatched properties from the message are deserialized this



17
18
19
 
# File 'lib/2019-10-01/generated/azure_mgmt_policy_insights/models/policy_state.rb', line 17

def additional_properties
  @additional_properties
end

#compliance_state ⇒ String

Returns Compliance state of the resource.

Returns:

  • (String) —

    Compliance state of the resource.



112
113
114
 
# File 'lib/2019-10-01/generated/azure_mgmt_policy_insights/models/policy_state.rb', line 112

def compliance_state
  @compliance_state
end

#components ⇒ Array<ComponentStateDetails>

records populated only when URL contains $expand=components clause.

Returns:



122
123
124
 
# File 'lib/2019-10-01/generated/azure_mgmt_policy_insights/models/policy_state.rb', line 122

def components
  @components
end

#effective_parameters ⇒ String

Returns Effective parameters for the policy assignment.

Returns:

  • (String) —

    Effective parameters for the policy assignment.



40
41
42
 
# File 'lib/2019-10-01/generated/azure_mgmt_policy_insights/models/policy_state.rb', line 40

def effective_parameters
  @effective_parameters
end

#is_compliant ⇒ Boolean

against the policy assignment it was evaluated against. This property is deprecated; please use ComplianceState instead.

Returns:

  • (Boolean) —

    Flag which states whether the resource is compliant



45
46
47
 
# File 'lib/2019-10-01/generated/azure_mgmt_policy_insights/models/policy_state.rb', line 45

def is_compliant
  @is_compliant
end

#management_group_ids ⇒ String

represent the hierarchy of the management groups the resource is under.

Returns:

  • (String) —

    Comma separated list of management group IDs, which



105
106
107
 
# File 'lib/2019-10-01/generated/azure_mgmt_policy_insights/models/policy_state.rb', line 105

def management_group_ids
  @management_group_ids
end

#odatacontext ⇒ String

type information based on metadata.

Returns:

  • (String) —

    OData context string; used by OData clients to resolve



25
26
27
 
# File 'lib/2019-10-01/generated/azure_mgmt_policy_insights/models/policy_state.rb', line 25

def odatacontext
  @odatacontext
end

#odataid ⇒ String

records do not have an entity ID.

Returns:

  • (String) —

    OData entity ID; always set to null since policy state



21
22
23
 
# File 'lib/2019-10-01/generated/azure_mgmt_policy_insights/models/policy_state.rb', line 21

def odataid
  @odataid
end

#policy_assignment_id ⇒ String

Returns Policy assignment ID.

Returns:

  • (String) —

    Policy assignment ID.



34
35
36
 
# File 'lib/2019-10-01/generated/azure_mgmt_policy_insights/models/policy_state.rb', line 34

def policy_assignment_id
  @policy_assignment_id
end

#policy_assignment_name ⇒ String

Returns Policy assignment name.

Returns:

  • (String) —

    Policy assignment name.



63
64
65
 
# File 'lib/2019-10-01/generated/azure_mgmt_policy_insights/models/policy_state.rb', line 63

def policy_assignment_name
  @policy_assignment_name
end

#policy_assignment_owner ⇒ String

Returns Policy assignment owner.

Returns:

  • (String) —

    Policy assignment owner.



66
67
68
 
# File 'lib/2019-10-01/generated/azure_mgmt_policy_insights/models/policy_state.rb', line 66

def policy_assignment_owner
  @policy_assignment_owner
end

#policy_assignment_parameters ⇒ String

Returns Policy assignment parameters.

Returns:

  • (String) —

    Policy assignment parameters.



69
70
71
 
# File 'lib/2019-10-01/generated/azure_mgmt_policy_insights/models/policy_state.rb', line 69

def policy_assignment_parameters
  @policy_assignment_parameters
end

#policy_assignment_scope ⇒ String

Returns Policy assignment scope.

Returns:

  • (String) —

    Policy assignment scope.



72
73
74
 
# File 'lib/2019-10-01/generated/azure_mgmt_policy_insights/models/policy_state.rb', line 72

def policy_assignment_scope
  @policy_assignment_scope
end

#policy_assignment_version ⇒ String

Returns Evaluated policy assignment version.

Returns:

  • (String) —

    Evaluated policy assignment version.



131
132
133
 
# File 'lib/2019-10-01/generated/azure_mgmt_policy_insights/models/policy_state.rb', line 131

def policy_assignment_version
  @policy_assignment_version
end

#policy_definition_action ⇒ String

Returns Policy definition action, i.e. effect.

Returns:

  • (String) —

    Policy definition action, i.e. effect.



78
79
80
 
# File 'lib/2019-10-01/generated/azure_mgmt_policy_insights/models/policy_state.rb', line 78

def policy_definition_action
  @policy_definition_action
end

#policy_definition_category ⇒ String

Returns Policy definition category.

Returns:

  • (String) —

    Policy definition category.



81
82
83
 
# File 'lib/2019-10-01/generated/azure_mgmt_policy_insights/models/policy_state.rb', line 81

def policy_definition_category
  @policy_definition_category
end

#policy_definition_group_names ⇒ Array<String>

Returns Policy definition group names.

Returns:

  • (Array<String>) —

    Policy definition group names.



118
119
120
 
# File 'lib/2019-10-01/generated/azure_mgmt_policy_insights/models/policy_state.rb', line 118

def policy_definition_group_names
  @policy_definition_group_names
end

#policy_definition_id ⇒ String

Returns Policy definition ID.

Returns:

  • (String) —

    Policy definition ID.



37
38
39
 
# File 'lib/2019-10-01/generated/azure_mgmt_policy_insights/models/policy_state.rb', line 37

def policy_definition_id
  @policy_definition_id
end

#policy_definition_name ⇒ String

Returns Policy definition name.

Returns:

  • (String) —

    Policy definition name.



75
76
77
 
# File 'lib/2019-10-01/generated/azure_mgmt_policy_insights/models/policy_state.rb', line 75

def policy_definition_name
  @policy_definition_name
end

#policy_definition_reference_id ⇒ String

policy set, if the policy assignment is for a policy set.

Returns:

  • (String) —

    Reference ID for the policy definition inside the



109
110
111
 
# File 'lib/2019-10-01/generated/azure_mgmt_policy_insights/models/policy_state.rb', line 109

def policy_definition_reference_id
  @policy_definition_reference_id
end

#policy_definition_version ⇒ String

Returns Evaluated policy definition version.

Returns:

  • (String) —

    Evaluated policy definition version.



125
126
127
 
# File 'lib/2019-10-01/generated/azure_mgmt_policy_insights/models/policy_state.rb', line 125

def policy_definition_version
  @policy_definition_version
end

#policy_evaluation_details ⇒ PolicyEvaluationDetails

Returns Policy evaluation details.

Returns:



115
116
117
 
# File 'lib/2019-10-01/generated/azure_mgmt_policy_insights/models/policy_state.rb', line 115

def policy_evaluation_details
  @policy_evaluation_details
end

#policy_set_definition_category ⇒ String

assignment is for a policy set.

Returns:

  • (String) —

    Policy set definition category, if the policy



97
98
99
 
# File 'lib/2019-10-01/generated/azure_mgmt_policy_insights/models/policy_state.rb', line 97

def policy_set_definition_category
  @policy_set_definition_category
end

#policy_set_definition_id ⇒ String

for a policy set.

Returns:

  • (String) —

    Policy set definition ID, if the policy assignment is



85
86
87
 
# File 'lib/2019-10-01/generated/azure_mgmt_policy_insights/models/policy_state.rb', line 85

def policy_set_definition_id
  @policy_set_definition_id
end

#policy_set_definition_name ⇒ String

is for a policy set.

Returns:

  • (String) —

    Policy set definition name, if the policy assignment



89
90
91
 
# File 'lib/2019-10-01/generated/azure_mgmt_policy_insights/models/policy_state.rb', line 89

def policy_set_definition_name
  @policy_set_definition_name
end

#policy_set_definition_owner ⇒ String

is for a policy set.

Returns:

  • (String) —

    Policy set definition owner, if the policy assignment



93
94
95
 
# File 'lib/2019-10-01/generated/azure_mgmt_policy_insights/models/policy_state.rb', line 93

def policy_set_definition_owner
  @policy_set_definition_owner
end

#policy_set_definition_parameters ⇒ String

assignment is for a policy set.

Returns:

  • (String) —

    Policy set definition parameters, if the policy



101
102
103
 
# File 'lib/2019-10-01/generated/azure_mgmt_policy_insights/models/policy_state.rb', line 101

def policy_set_definition_parameters
  @policy_set_definition_parameters
end

#policy_set_definition_version ⇒ String

Returns Evaluated policy set definition version.

Returns:

  • (String) —

    Evaluated policy set definition version.



128
129
130
 
# File 'lib/2019-10-01/generated/azure_mgmt_policy_insights/models/policy_state.rb', line 128

def policy_set_definition_version
  @policy_set_definition_version
end

#resource_group ⇒ String

Returns Resource group name.

Returns:

  • (String) —

    Resource group name.



57
58
59
 
# File 'lib/2019-10-01/generated/azure_mgmt_policy_insights/models/policy_state.rb', line 57

def resource_group
  @resource_group
end

#resource_id ⇒ String

Returns Resource ID.

Returns:

  • (String) —

    Resource ID.



31
32
33
 
# File 'lib/2019-10-01/generated/azure_mgmt_policy_insights/models/policy_state.rb', line 31

def resource_id
  @resource_id
end

#resource_location ⇒ String

Returns Resource location.

Returns:

  • (String) —

    Resource location.



54
55
56
 
# File 'lib/2019-10-01/generated/azure_mgmt_policy_insights/models/policy_state.rb', line 54

def resource_location
  @resource_location
end

#resource_tags ⇒ String

Returns List of resource tags.

Returns:

  • (String) —

    List of resource tags.



60
61
62
 
# File 'lib/2019-10-01/generated/azure_mgmt_policy_insights/models/policy_state.rb', line 60

def resource_tags
  @resource_tags
end

#resource_type ⇒ String

Returns Resource type.

Returns:

  • (String) —

    Resource type.



51
52
53
 
# File 'lib/2019-10-01/generated/azure_mgmt_policy_insights/models/policy_state.rb', line 51

def resource_type
  @resource_type
end

#subscription_id ⇒ String

Returns Subscription ID.

Returns:

  • (String) —

    Subscription ID.



48
49
50
 
# File 'lib/2019-10-01/generated/azure_mgmt_policy_insights/models/policy_state.rb', line 48

def subscription_id
  @subscription_id
end

#timestamp ⇒ DateTime

Returns Timestamp for the policy state record.

Returns:

  • (DateTime) —

    Timestamp for the policy state record.



28
29
30
 
# File 'lib/2019-10-01/generated/azure_mgmt_policy_insights/models/policy_state.rb', line 28

def timestamp
  @timestamp
end

Class Method Details

.mapper ⇒ Object

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



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
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
 
# File 'lib/2019-10-01/generated/azure_mgmt_policy_insights/models/policy_state.rb', line 138

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'PolicyState',
    type: {
      name: 'Composite',
      class_name: 'PolicyState',
      model_properties: {
        additional_properties: {
          client_side_validation: true,
          required: false,
          type: {
            name: 'Dictionary',
            value: {
                client_side_validation: true,
                required: false,
                serialized_name: 'ObjectElementType',
                type: {
                  name: 'Object'
                }
            }
          }
        },
        odataid: {
          client_side_validation: true,
          required: false,
          serialized_name: '@odata\\.id',
          type: {
            name: 'String'
          }
        },
        odatacontext: {
          client_side_validation: true,
          required: false,
          serialized_name: '@odata\\.context',
          type: {
            name: 'String'
          }
        },
        timestamp: {
          client_side_validation: true,
          required: false,
          serialized_name: 'timestamp',
          type: {
            name: 'DateTime'
          }
        },
        resource_id: {
          client_side_validation: true,
          required: false,
          serialized_name: 'resourceId',
          type: {
            name: 'String'
          }
        },
        policy_assignment_id: {
          client_side_validation: true,
          required: false,
          serialized_name: 'policyAssignmentId',
          type: {
            name: 'String'
          }
        },
        policy_definition_id: {
          client_side_validation: true,
          required: false,
          serialized_name: 'policyDefinitionId',
          type: {
            name: 'String'
          }
        },
        effective_parameters: {
          client_side_validation: true,
          required: false,
          serialized_name: 'effectiveParameters',
          type: {
            name: 'String'
          }
        },
        is_compliant: {
          client_side_validation: true,
          required: false,
          serialized_name: 'isCompliant',
          type: {
            name: 'Boolean'
          }
        },
        subscription_id: {
          client_side_validation: true,
          required: false,
          serialized_name: 'subscriptionId',
          type: {
            name: 'String'
          }
        },
        resource_type: {
          client_side_validation: true,
          required: false,
          serialized_name: 'resourceType',
          type: {
            name: 'String'
          }
        },
        resource_location: {
          client_side_validation: true,
          required: false,
          serialized_name: 'resourceLocation',
          type: {
            name: 'String'
          }
        },
        resource_group: {
          client_side_validation: true,
          required: false,
          serialized_name: 'resourceGroup',
          type: {
            name: 'String'
          }
        },
        resource_tags: {
          client_side_validation: true,
          required: false,
          serialized_name: 'resourceTags',
          type: {
            name: 'String'
          }
        },
        policy_assignment_name: {
          client_side_validation: true,
          required: false,
          serialized_name: 'policyAssignmentName',
          type: {
            name: 'String'
          }
        },
        policy_assignment_owner: {
          client_side_validation: true,
          required: false,
          serialized_name: 'policyAssignmentOwner',
          type: {
            name: 'String'
          }
        },
        policy_assignment_parameters: {
          client_side_validation: true,
          required: false,
          serialized_name: 'policyAssignmentParameters',
          type: {
            name: 'String'
          }
        },
        policy_assignment_scope: {
          client_side_validation: true,
          required: false,
          serialized_name: 'policyAssignmentScope',
          type: {
            name: 'String'
          }
        },
        policy_definition_name: {
          client_side_validation: true,
          required: false,
          serialized_name: 'policyDefinitionName',
          type: {
            name: 'String'
          }
        },
        policy_definition_action: {
          client_side_validation: true,
          required: false,
          serialized_name: 'policyDefinitionAction',
          type: {
            name: 'String'
          }
        },
        policy_definition_category: {
          client_side_validation: true,
          required: false,
          serialized_name: 'policyDefinitionCategory',
          type: {
            name: 'String'
          }
        },
        policy_set_definition_id: {
          client_side_validation: true,
          required: false,
          serialized_name: 'policySetDefinitionId',
          type: {
            name: 'String'
          }
        },
        policy_set_definition_name: {
          client_side_validation: true,
          required: false,
          serialized_name: 'policySetDefinitionName',
          type: {
            name: 'String'
          }
        },
        policy_set_definition_owner: {
          client_side_validation: true,
          required: false,
          serialized_name: 'policySetDefinitionOwner',
          type: {
            name: 'String'
          }
        },
        policy_set_definition_category: {
          client_side_validation: true,
          required: false,
          serialized_name: 'policySetDefinitionCategory',
          type: {
            name: 'String'
          }
        },
        policy_set_definition_parameters: {
          client_side_validation: true,
          required: false,
          serialized_name: 'policySetDefinitionParameters',
          type: {
            name: 'String'
          }
        },
        management_group_ids: {
          client_side_validation: true,
          required: false,
          serialized_name: 'managementGroupIds',
          type: {
            name: 'String'
          }
        },
        policy_definition_reference_id: {
          client_side_validation: true,
          required: false,
          serialized_name: 'policyDefinitionReferenceId',
          type: {
            name: 'String'
          }
        },
        compliance_state: {
          client_side_validation: true,
          required: false,
          serialized_name: 'complianceState',
          type: {
            name: 'String'
          }
        },
        policy_evaluation_details: {
          client_side_validation: true,
          required: false,
          serialized_name: 'policyEvaluationDetails',
          type: {
            name: 'Composite',
            class_name: 'PolicyEvaluationDetails'
          }
        },
        policy_definition_group_names: {
          client_side_validation: true,
          required: false,
          serialized_name: 'policyDefinitionGroupNames',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'StringElementType',
                type: {
                  name: 'String'
                }
            }
          }
        },
        components: {
          client_side_validation: true,
          required: false,
          serialized_name: 'components',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'ComponentStateDetailsElementType',
                type: {
                  name: 'Composite',
                  class_name: 'ComponentStateDetails'
                }
            }
          }
        },
        policy_definition_version: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'policyDefinitionVersion',
          type: {
            name: 'String'
          }
        },
        policy_set_definition_version: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'policySetDefinitionVersion',
          type: {
            name: 'String'
          }
        },
        policy_assignment_version: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'policyAssignmentVersion',
          type: {
            name: 'String'
          }
        }
      }
    }
  }
end