class Azure::PolicyInsights::Mgmt::V2019_10_01::Models::PolicyEvent

Policy event record.

Attributes

additional_properties[RW]

@return Unmatched properties from the message are deserialized this collection

compliance_state[RW]

@return [String] Compliance state of the resource.

components[RW]

@return [Array<ComponentEventDetails>] Components events records populated only when URL contains $expand=components clause.

effective_parameters[RW]

@return [String] Effective parameters for the policy assignment.

is_compliant[RW]

@return [Boolean] Flag which states whether the resource is compliant against the policy assignment it was evaluated against.

management_group_ids[RW]

@return [String] Comma separated list of management group IDs, which represent the hierarchy of the management groups the resource is under.

odatacontext[RW]

@return [String] OData context string; used by OData clients to resolve type information based on metadata.

odataid[RW]

@return [String] OData entity ID; always set to null since policy event records do not have an entity ID.

policy_assignment_id[RW]

@return [String] Policy assignment ID.

policy_assignment_name[RW]

@return [String] Policy assignment name.

policy_assignment_owner[RW]

@return [String] Policy assignment owner.

policy_assignment_parameters[RW]

@return [String] Policy assignment parameters.

policy_assignment_scope[RW]

@return [String] Policy assignment scope.

policy_definition_action[RW]

@return [String] Policy definition action, i.e. effect.

policy_definition_category[RW]

@return [String] Policy definition category.

policy_definition_id[RW]

@return [String] Policy definition ID.

policy_definition_name[RW]

@return [String] Policy definition name.

policy_definition_reference_id[RW]

@return [String] Reference ID for the policy definition inside the policy set, if the policy assignment is for a policy set.

policy_set_definition_category[RW]

@return [String] Policy set definition category, if the policy assignment is for a policy set.

policy_set_definition_id[RW]

@return [String] Policy set definition ID, if the policy assignment is for a policy set.

policy_set_definition_name[RW]

@return [String] Policy set definition name, if the policy assignment is for a policy set.

policy_set_definition_owner[RW]

@return [String] Policy set definition owner, if the policy assignment is for a policy set.

policy_set_definition_parameters[RW]

@return [String] Policy set definition parameters, if the policy assignment is for a policy set.

principal_oid[RW]

@return [String] Principal object ID for the user who initiated the resource operation that triggered the policy event.

resource_group[RW]

@return [String] Resource group name.

resource_id[RW]

@return [String] Resource ID.

resource_location[RW]

@return [String] Resource location.

resource_tags[RW]

@return [String] List of resource tags.

resource_type[RW]

@return [String] Resource type.

subscription_id[RW]

@return [String] Subscription ID.

tenant_id[RW]

@return [String] Tenant ID for the policy event record.

timestamp[RW]

@return [DateTime] Timestamp for the policy event record.

Private Class Methods

mapper() click to toggle source

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

# File lib/2019-10-01/generated/azure_mgmt_policy_insights/models/policy_event.rb, line 129
def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'PolicyEvent',
    type: {
      name: 'Composite',
      class_name: 'PolicyEvent',
      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'
          }
        },
        tenant_id: {
          client_side_validation: true,
          required: false,
          serialized_name: 'tenantId',
          type: {
            name: 'String'
          }
        },
        principal_oid: {
          client_side_validation: true,
          required: false,
          serialized_name: 'principalOid',
          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: 'ComponentEventDetailsElementType',
                type: {
                  name: 'Composite',
                  class_name: 'ComponentEventDetails'
                }
            }
          }
        }
      }
    }
  }
end