Class SecurityMonitoringRuleUpdatePayload

Update an existing rule.

Hierarchy

  • SecurityMonitoringRuleUpdatePayload

Constructors

constructor

Properties

additionalProperties? cases? complianceSignalOptions? customMessage? customName? filters? groupSignalsBy? hasExtendedTitle? isEnabled? message? name? options? queries? referenceTables? tags? thirdPartyCases? version?

Constructors

constructor

Properties

Optional additionalProperties

additionalProperties?: {
    [key: string]: any;
}

A container for additional, undeclared properties. This is a holder for any undeclared properties as specified with the 'additionalProperties' keyword in the OAS document.

Type declaration

  • [key: string]: any

Optional cases

cases?: SecurityMonitoringRuleCase[]

Cases for generating signals.

Optional complianceSignalOptions

complianceSignalOptions?: CloudConfigurationRuleComplianceSignalOptions

How to generate compliance signals. Useful for cloud_configuration rules only.

Optional customMessage

customMessage?: string

Custom/Overridden Message for generated signals (used in case of Default rule update).

Optional customName

customName?: string

Custom/Overridden name (used in case of Default rule update).

Optional filters

filters?: SecurityMonitoringFilter[]

Additional queries to filter matched events before they are processed. This field is deprecated for log detection, signal correlation, and workload security rules.

Optional groupSignalsBy

groupSignalsBy?: string[]

Additional grouping to perform on top of the existing groups in the query section. Must be a subset of the existing groups.

Optional hasExtendedTitle

hasExtendedTitle?: boolean

Whether the notifications include the triggering group-by values in their title.

Optional isEnabled

isEnabled?: boolean

Whether the rule is enabled.

Optional message

message?: string

Message for generated signals.

Optional name

name?: string

Name of the rule.

Optional options

options?: SecurityMonitoringRuleOptions

Options.

Optional queries

queries?: SecurityMonitoringRuleQuery[]

Queries for selecting logs which are part of the rule.

Optional referenceTables

referenceTables?: SecurityMonitoringReferenceTable[]

Reference tables for the rule.

Optional tags

tags?: string[]

Tags for generated signals.

Optional thirdPartyCases

thirdPartyCases?: SecurityMonitoringThirdPartyRuleCase[]

Cases for generating signals from third-party rules. Only available for third-party rules.

Optional version

version?: number

The version of the rule being updated.

Settings

Member Visibility

Theme

Generated using TypeDoc