Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface NrtAlertRule

Package version

Represents NRT alert rule.

Hierarchy

Index

Properties

Optional alertDetailsOverride

alertDetailsOverride: AlertDetailsOverride

The alert details override settings

Optional alertRuleTemplateName

alertRuleTemplateName: undefined | string

The Name of the alert rule template used to create this rule.

Optional customDetails

customDetails: undefined | {}

Dictionary of string key-value pairs of columns to be attached to the alert

Optional description

description: undefined | string

The description of the alert rule.

Optional displayName

displayName: undefined | string

The display name for alerts created by this alert rule.

Optional enabled

enabled: undefined | false | true

Determines whether this alert rule is enabled or disabled.

Optional entityMappings

entityMappings: EntityMapping[]

Array of the entity mappings of the alert rule

Optional etag

etag: undefined | string

Etag of the azure resource

Optional eventGroupingSettings

eventGroupingSettings: EventGroupingSettings

The event grouping settings.

Optional id

id: undefined | string

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.

Optional incidentConfiguration

incidentConfiguration: IncidentConfiguration

The settings of the incidents that created from alerts triggered by this analytics rule

kind

kind: "NRT"

Polymorphic discriminator, which specifies the different types this object can be

Optional lastModifiedUtc

lastModifiedUtc: Date

The last time that this alert rule has been modified. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

Optional query

query: undefined | string

The query that creates alerts for this rule.

Optional severity

severity: AlertSeverity

The severity for alerts created by this alert rule.

Optional suppressionDuration

suppressionDuration: undefined | string

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

Optional suppressionEnabled

suppressionEnabled: undefined | false | true

Determines whether the suppression for this alert rule is enabled or disabled.

Optional systemData

systemData: SystemData

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.

Optional tactics

tactics: AttackTactic[]

The tactics of the alert rule

Optional techniques

techniques: string[]

The techniques of the alert rule

Optional templateVersion

templateVersion: undefined | string

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>

Optional type

type: undefined | string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

Generated using TypeDoc