java.lang.Object
- com.azure.resourcemanager.securityinsights.models.ScheduledAlertRuleCommonProperties
- - com.azure.resourcemanager.securityinsights.fluent.models.ScheduledAlertRuleProperties

public final class ScheduledAlertRuleProperties
extends ScheduledAlertRuleCommonProperties

Scheduled alert rule base property bag.

Constructor Summary

Constructors
Constructor Description

ScheduledAlertRuleProperties()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`alertRuleTemplateName()`	Get the alertRuleTemplateName property: The Name of the alert rule template used to create this rule.
`String`	`description()`	Get the description property: The description of the alert rule.
`String`	`displayName()`	Get the displayName property: The display name for alerts created by this alert rule.
`boolean`	`enabled()`	Get the enabled property: Determines whether this alert rule is enabled or disabled.
`IncidentConfiguration`	`incidentConfiguration()`	Get the incidentConfiguration property: The settings of the incidents that created from alerts triggered by this analytics rule.
`OffsetDateTime`	`lastModifiedUtc()`	Get the lastModifiedUtc property: The last time that this alert rule has been modified.
`Duration`	`suppressionDuration()`	Get the suppressionDuration property: The suppression (in ISO 8601 duration format) to wait since last time this alert rule been triggered.
`boolean`	`suppressionEnabled()`	Get the suppressionEnabled property: Determines whether the suppression for this alert rule is enabled or disabled.
`List<AttackTactic>`	`tactics()`	Get the tactics property: The tactics of the alert rule.
`List<String>`	`techniques()`	Get the techniques property: The techniques of the alert rule.
`String`	`templateVersion()`	Get the templateVersion property: The version of the alert rule template used to create this rule - in format <a.b.c>, where all are numbers, for example 0 <1.0.2>.
`void`	`validate()`	Validates the instance.
`ScheduledAlertRuleProperties`	`withAlertDetailsOverride(AlertDetailsOverride alertDetailsOverride)`	Set the alertDetailsOverride property: The alert details override settings.
`ScheduledAlertRuleProperties`	`withAlertRuleTemplateName(String alertRuleTemplateName)`	Set the alertRuleTemplateName property: The Name of the alert rule template used to create this rule.
`ScheduledAlertRuleProperties`	`withCustomDetails(Map<String,String> customDetails)`	Set the customDetails property: Dictionary of string key-value pairs of columns to be attached to the alert.
`ScheduledAlertRuleProperties`	`withDescription(String description)`	Set the description property: The description of the alert rule.
`ScheduledAlertRuleProperties`	`withDisplayName(String displayName)`	Set the displayName property: The display name for alerts created by this alert rule.
`ScheduledAlertRuleProperties`	`withEnabled(boolean enabled)`	Set the enabled property: Determines whether this alert rule is enabled or disabled.
`ScheduledAlertRuleProperties`	`withEntityMappings(List<EntityMapping> entityMappings)`	Set the entityMappings property: Array of the entity mappings of the alert rule.
`ScheduledAlertRuleProperties`	`withEventGroupingSettings(EventGroupingSettings eventGroupingSettings)`	Set the eventGroupingSettings property: The event grouping settings.
`ScheduledAlertRuleProperties`	`withIncidentConfiguration(IncidentConfiguration incidentConfiguration)`	Set the incidentConfiguration property: The settings of the incidents that created from alerts triggered by this analytics rule.
`ScheduledAlertRuleProperties`	`withQuery(String query)`	Set the query property: The query that creates alerts for this rule.
`ScheduledAlertRuleProperties`	`withQueryFrequency(Duration queryFrequency)`	Set the queryFrequency property: The frequency (in ISO 8601 duration format) for this alert rule to run.
`ScheduledAlertRuleProperties`	`withQueryPeriod(Duration queryPeriod)`	Set the queryPeriod property: The period (in ISO 8601 duration format) that this alert rule looks at.
`ScheduledAlertRuleProperties`	`withSeverity(AlertSeverity severity)`	Set the severity property: The severity for alerts created by this alert rule.
`ScheduledAlertRuleProperties`	`withSuppressionDuration(Duration suppressionDuration)`	Set the suppressionDuration property: The suppression (in ISO 8601 duration format) to wait since last time this alert rule been triggered.
`ScheduledAlertRuleProperties`	`withSuppressionEnabled(boolean suppressionEnabled)`	Set the suppressionEnabled property: Determines whether the suppression for this alert rule is enabled or disabled.
`ScheduledAlertRuleProperties`	`withTactics(List<AttackTactic> tactics)`	Set the tactics property: The tactics of the alert rule.
`ScheduledAlertRuleProperties`	`withTechniques(List<String> techniques)`	Set the techniques property: The techniques of the alert rule.
`ScheduledAlertRuleProperties`	`withTemplateVersion(String templateVersion)`	Set the templateVersion property: The version of the alert rule template used to create this rule - in format <a.b.c>, where all are numbers, for example 0 <1.0.2>.
`ScheduledAlertRuleProperties`	`withTriggerOperator(TriggerOperator triggerOperator)`	Set the triggerOperator property: The operation against the threshold that triggers alert rule.
`ScheduledAlertRuleProperties`	`withTriggerThreshold(Integer triggerThreshold)`	Set the triggerThreshold property: The threshold triggers this alert rule.

Methods inherited from class com.azure.resourcemanager.securityinsights.models.ScheduledAlertRuleCommonProperties
alertDetailsOverride, customDetails, entityMappings, eventGroupingSettings, query, queryFrequency, queryPeriod, severity, triggerOperator, triggerThreshold

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ScheduledAlertRuleProperties
```
public ScheduledAlertRuleProperties()
```
- Method Detail
  - alertRuleTemplateName
```
public String alertRuleTemplateName()
```
    Get the alertRuleTemplateName property: The Name of the alert rule template used to create this rule.
    
    Returns:
    
    the alertRuleTemplateName value.
  - withAlertRuleTemplateName
```
public ScheduledAlertRuleProperties withAlertRuleTemplateName(String alertRuleTemplateName)
```
    Set the alertRuleTemplateName property: The Name of the alert rule template used to create this rule.
    
    Parameters:
    
    alertRuleTemplateName - the alertRuleTemplateName value to set.
    
    Returns:
    
    the ScheduledAlertRuleProperties object itself.
  - templateVersion
```
public String templateVersion()
```
    Get the templateVersion property: The version of the alert rule template used to create this rule - in format <a.b.c>, where all are numbers, for example 0 <1.0.2>.
    
    Returns:
    
    the templateVersion value.
  - withTemplateVersion
```
public ScheduledAlertRuleProperties withTemplateVersion(String templateVersion)
```
    Set the templateVersion property: The version of the alert rule template used to create this rule - in format <a.b.c>, where all are numbers, for example 0 <1.0.2>.
    
    Parameters:
    
    templateVersion - the templateVersion value to set.
    
    Returns:
    
    the ScheduledAlertRuleProperties object itself.
  - description
```
public String description()
```
    Get the description property: The description of the alert rule.
    
    Returns:
    
    the description value.
  - withDescription
```
public ScheduledAlertRuleProperties withDescription(String description)
```
    Set the description property: The description of the alert rule.
    
    Parameters:
    
    description - the description value to set.
    
    Returns:
    
    the ScheduledAlertRuleProperties object itself.
  - displayName
```
public String displayName()
```
    Get the displayName property: The display name for alerts created by this alert rule.
    
    Returns:
    
    the displayName value.
  - withDisplayName
```
public ScheduledAlertRuleProperties withDisplayName(String displayName)
```
    Set the displayName property: The display name for alerts created by this alert rule.
    
    Parameters:
    
    displayName - the displayName value to set.
    
    Returns:
    
    the ScheduledAlertRuleProperties object itself.
  - enabled
```
public boolean enabled()
```
    Get the enabled property: Determines whether this alert rule is enabled or disabled.
    
    Returns:
    
    the enabled value.
  - withEnabled
```
public ScheduledAlertRuleProperties withEnabled(boolean enabled)
```
    Set the enabled property: Determines whether this alert rule is enabled or disabled.
    
    Parameters:
    
    enabled - the enabled value to set.
    
    Returns:
    
    the ScheduledAlertRuleProperties object itself.
  - lastModifiedUtc
```
public OffsetDateTime lastModifiedUtc()
```
    Get the lastModifiedUtc property: The last time that this alert rule has been modified.
    
    Returns:
    
    the lastModifiedUtc value.
  - suppressionDuration
```
public Duration suppressionDuration()
```
    Get the suppressionDuration property: The suppression (in ISO 8601 duration format) to wait since last time this alert rule been triggered.
    
    Returns:
    
    the suppressionDuration value.
  - withSuppressionDuration
```
public ScheduledAlertRuleProperties withSuppressionDuration(Duration suppressionDuration)
```
    Set the suppressionDuration property: The suppression (in ISO 8601 duration format) to wait since last time this alert rule been triggered.
    
    Parameters:
    
    suppressionDuration - the suppressionDuration value to set.
    
    Returns:
    
    the ScheduledAlertRuleProperties object itself.
  - suppressionEnabled
```
public boolean suppressionEnabled()
```
    Get the suppressionEnabled property: Determines whether the suppression for this alert rule is enabled or disabled.
    
    Returns:
    
    the suppressionEnabled value.
  - withSuppressionEnabled
```
public ScheduledAlertRuleProperties withSuppressionEnabled(boolean suppressionEnabled)
```
    Set the suppressionEnabled property: Determines whether the suppression for this alert rule is enabled or disabled.
    
    Parameters:
    
    suppressionEnabled - the suppressionEnabled value to set.
    
    Returns:
    
    the ScheduledAlertRuleProperties object itself.
  - tactics
```
public List<AttackTactic> tactics()
```
    Get the tactics property: The tactics of the alert rule.
    
    Returns:
    
    the tactics value.
  - withTactics
```
public ScheduledAlertRuleProperties withTactics(List<AttackTactic> tactics)
```
    Set the tactics property: The tactics of the alert rule.
    
    Parameters:
    
    tactics - the tactics value to set.
    
    Returns:
    
    the ScheduledAlertRuleProperties object itself.
  - techniques
```
public List<String> techniques()
```
    Get the techniques property: The techniques of the alert rule.
    
    Returns:
    
    the techniques value.
  - withTechniques
```
public ScheduledAlertRuleProperties withTechniques(List<String> techniques)
```
    Set the techniques property: The techniques of the alert rule.
    
    Parameters:
    
    techniques - the techniques value to set.
    
    Returns:
    
    the ScheduledAlertRuleProperties object itself.
  - incidentConfiguration
```
public IncidentConfiguration incidentConfiguration()
```
    Get the incidentConfiguration property: The settings of the incidents that created from alerts triggered by this analytics rule.
    
    Returns:
    
    the incidentConfiguration value.
  - withIncidentConfiguration
```
public ScheduledAlertRuleProperties withIncidentConfiguration(IncidentConfiguration incidentConfiguration)
```
    Set the incidentConfiguration property: The settings of the incidents that created from alerts triggered by this analytics rule.
    
    Parameters:
    
    incidentConfiguration - the incidentConfiguration value to set.
    
    Returns:
    
    the ScheduledAlertRuleProperties object itself.
  - withQuery
```
public ScheduledAlertRuleProperties withQuery(String query)
```
    Set the query property: The query that creates alerts for this rule.
    
    Overrides:
    
    withQuery in class ScheduledAlertRuleCommonProperties
    
    Parameters:
    
    query - the query value to set.
    
    Returns:
    
    the ScheduledAlertRuleCommonProperties object itself.
  - withQueryFrequency
```
public ScheduledAlertRuleProperties withQueryFrequency(Duration queryFrequency)
```
    Set the queryFrequency property: The frequency (in ISO 8601 duration format) for this alert rule to run.
    
    Overrides:
    
    withQueryFrequency in class ScheduledAlertRuleCommonProperties
    
    Parameters:
    
    queryFrequency - the queryFrequency value to set.
    
    Returns:
    
    the ScheduledAlertRuleCommonProperties object itself.
  - withQueryPeriod
```
public ScheduledAlertRuleProperties withQueryPeriod(Duration queryPeriod)
```
    Set the queryPeriod property: The period (in ISO 8601 duration format) that this alert rule looks at.
    
    Overrides:
    
    withQueryPeriod in class ScheduledAlertRuleCommonProperties
    
    Parameters:
    
    queryPeriod - the queryPeriod value to set.
    
    Returns:
    
    the ScheduledAlertRuleCommonProperties object itself.
  - withSeverity
```
public ScheduledAlertRuleProperties withSeverity(AlertSeverity severity)
```
    Set the severity property: The severity for alerts created by this alert rule.
    
    Overrides:
    
    withSeverity in class ScheduledAlertRuleCommonProperties
    
    Parameters:
    
    severity - the severity value to set.
    
    Returns:
    
    the ScheduledAlertRuleCommonProperties object itself.
  - withTriggerOperator
```
public ScheduledAlertRuleProperties withTriggerOperator(TriggerOperator triggerOperator)
```
    Set the triggerOperator property: The operation against the threshold that triggers alert rule.
    
    Overrides:
    
    withTriggerOperator in class ScheduledAlertRuleCommonProperties
    
    Parameters:
    
    triggerOperator - the triggerOperator value to set.
    
    Returns:
    
    the ScheduledAlertRuleCommonProperties object itself.
  - withTriggerThreshold
```
public ScheduledAlertRuleProperties withTriggerThreshold(Integer triggerThreshold)
```
    Set the triggerThreshold property: The threshold triggers this alert rule.
    
    Overrides:
    
    withTriggerThreshold in class ScheduledAlertRuleCommonProperties
    
    Parameters:
    
    triggerThreshold - the triggerThreshold value to set.
    
    Returns:
    
    the ScheduledAlertRuleCommonProperties object itself.
  - withEventGroupingSettings
```
public ScheduledAlertRuleProperties withEventGroupingSettings(EventGroupingSettings eventGroupingSettings)
```
    Set the eventGroupingSettings property: The event grouping settings.
    
    Overrides:
    
    withEventGroupingSettings in class ScheduledAlertRuleCommonProperties
    
    Parameters:
    
    eventGroupingSettings - the eventGroupingSettings value to set.
    
    Returns:
    
    the ScheduledAlertRuleCommonProperties object itself.
  - withCustomDetails
```
public ScheduledAlertRuleProperties withCustomDetails(Map<String,String> customDetails)
```
    Set the customDetails property: Dictionary of string key-value pairs of columns to be attached to the alert.
    
    Overrides:
    
    withCustomDetails in class ScheduledAlertRuleCommonProperties
    
    Parameters:
    
    customDetails - the customDetails value to set.
    
    Returns:
    
    the ScheduledAlertRuleCommonProperties object itself.
  - withEntityMappings
```
public ScheduledAlertRuleProperties withEntityMappings(List<EntityMapping> entityMappings)
```
    Set the entityMappings property: Array of the entity mappings of the alert rule.
    
    Overrides:
    
    withEntityMappings in class ScheduledAlertRuleCommonProperties
    
    Parameters:
    
    entityMappings - the entityMappings value to set.
    
    Returns:
    
    the ScheduledAlertRuleCommonProperties object itself.
  - withAlertDetailsOverride
```
public ScheduledAlertRuleProperties withAlertDetailsOverride(AlertDetailsOverride alertDetailsOverride)
```
    Set the alertDetailsOverride property: The alert details override settings.
    
    Overrides:
    
    withAlertDetailsOverride in class ScheduledAlertRuleCommonProperties
    
    Parameters:
    
    alertDetailsOverride - the alertDetailsOverride value to set.
    
    Returns:
    
    the ScheduledAlertRuleCommonProperties object itself.
  - validate
```
public void validate()
```
    Validates the instance.
    
    Overrides:
    
    validate in class ScheduledAlertRuleCommonProperties
    
    Throws:
    
    IllegalArgumentException - thrown if the instance is not valid.

Class ScheduledAlertRuleProperties

Constructor Summary

Method Summary

Methods inherited from class com.azure.resourcemanager.securityinsights.models.ScheduledAlertRuleCommonProperties

Methods inherited from class java.lang.Object

Constructor Detail

ScheduledAlertRuleProperties

Method Detail

alertRuleTemplateName

withAlertRuleTemplateName

templateVersion

withTemplateVersion

description

withDescription

displayName

withDisplayName

enabled

withEnabled

lastModifiedUtc

suppressionDuration

withSuppressionDuration

suppressionEnabled

withSuppressionEnabled

tactics

withTactics

techniques

withTechniques

incidentConfiguration

withIncidentConfiguration

withQuery

withQueryFrequency

withQueryPeriod

withSeverity

withTriggerOperator

withTriggerThreshold

withEventGroupingSettings

withCustomDetails

withEntityMappings

withAlertDetailsOverride

validate