class Azure::SecurityInsights::Mgmt::V2020_01_01::Models::ScheduledAlertRule

Represents scheduled alert rule.

Attributes

alert_rule_template_name[RW]

@return [String] The Name of the alert rule template used to create this rule.

description[RW]

@return [String] The description of the alert rule.

display_name[RW]

@return [String] The display name for alerts created by this alert rule.

enabled[RW]

@return [Boolean] Determines whether this alert rule is enabled or disabled.

kind[RW]
last_modified_utc[RW]

@return [DateTime] The last time that this alert rule has been modified.

query[RW]

@return [String] The query that creates alerts for this rule.

query_frequency[RW]

@return [Duration] The frequency (in ISO 8601 duration format) for this alert rule to run.

query_period[RW]

@return [Duration] The period (in ISO 8601 duration format) that this alert rule looks at.

severity[RW]

@return [AlertSeverity] The severity for alerts created by this alert rule. Possible values include: 'High', 'Medium', 'Low', 'Informational'

suppression_duration[RW]

@return [Duration] The suppression (in ISO 8601 duration format) to wait since last time this alert rule been triggered.

suppression_enabled[RW]

@return [Boolean] Determines whether the suppression for this alert rule is enabled or disabled.

tactics[RW]

@return [Array<AttackTactic>] The tactics of the alert rule

trigger_operator[RW]

@return [TriggerOperator] The operation against the threshold that triggers alert rule. Possible values include: 'GreaterThan', 'LessThan', 'Equal', 'NotEqual'

trigger_threshold[RW]

@return [Integer] The threshold triggers this alert rule.

Private Class Methods

mapper() click to toggle source

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

# File lib/2020-01-01/generated/azure_mgmt_security_insights/models/scheduled_alert_rule.rb, line 80
def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'Scheduled',
    type: {
      name: 'Composite',
      class_name: 'ScheduledAlertRule',
      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'
          }
        },
        etag: {
          client_side_validation: true,
          required: false,
          serialized_name: 'etag',
          type: {
            name: 'String'
          }
        },
        kind: {
          client_side_validation: true,
          required: true,
          serialized_name: 'kind',
          type: {
            name: 'String'
          }
        },
        query: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.query',
          type: {
            name: 'String'
          }
        },
        query_frequency: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.queryFrequency',
          type: {
            name: 'TimeSpan'
          }
        },
        query_period: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.queryPeriod',
          type: {
            name: 'TimeSpan'
          }
        },
        severity: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.severity',
          type: {
            name: 'String'
          }
        },
        trigger_operator: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.triggerOperator',
          type: {
            name: 'Enum',
            module: 'TriggerOperator'
          }
        },
        trigger_threshold: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.triggerThreshold',
          type: {
            name: 'Number'
          }
        },
        alert_rule_template_name: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.alertRuleTemplateName',
          type: {
            name: 'String'
          }
        },
        description: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.description',
          type: {
            name: 'String'
          }
        },
        display_name: {
          client_side_validation: true,
          required: true,
          serialized_name: 'properties.displayName',
          type: {
            name: 'String'
          }
        },
        enabled: {
          client_side_validation: true,
          required: true,
          serialized_name: 'properties.enabled',
          type: {
            name: 'Boolean'
          }
        },
        last_modified_utc: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.lastModifiedUtc',
          type: {
            name: 'DateTime'
          }
        },
        suppression_duration: {
          client_side_validation: true,
          required: true,
          serialized_name: 'properties.suppressionDuration',
          type: {
            name: 'TimeSpan'
          }
        },
        suppression_enabled: {
          client_side_validation: true,
          required: true,
          serialized_name: 'properties.suppressionEnabled',
          type: {
            name: 'Boolean'
          }
        },
        tactics: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.tactics',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'AttackTacticElementType',
                type: {
                  name: 'String'
                }
            }
          }
        }
      }
    }
  }
end
new() click to toggle source
# File lib/2020-01-01/generated/azure_mgmt_security_insights/models/scheduled_alert_rule.rb, line 16
def initialize
  @kind = "Scheduled"
end