ScheduledAlertRule interface

Represents scheduled alert rule.

Extends

Properties

alertDetailsOverride

The alert details override settings

alertRuleTemplateName

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

customDetails

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

description

The description of the alert rule.

displayName

The display name for alerts created by this alert rule.

enabled

Determines whether this alert rule is enabled or disabled.

entityMappings

Array of the entity mappings of the alert rule

eventGroupingSettings

The event grouping settings.

incidentConfiguration

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

kind

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

lastModifiedUtc

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.

query

The query that creates alerts for this rule.

queryFrequency

The frequency (in ISO 8601 duration format) for this alert rule to run.

queryPeriod

The period (in ISO 8601 duration format) that this alert rule looks at.

severity

The severity for alerts created by this alert rule.

suppressionDuration

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

suppressionEnabled

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

tactics

The tactics of the alert rule

techniques

The techniques of the alert rule

templateVersion

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>

triggerOperator

The operation against the threshold that triggers alert rule.

triggerThreshold

The threshold triggers this alert rule.

Inherited Properties

etag

Etag of the azure resource

id

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.

name

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

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.

type

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.

Property Details

alertDetailsOverride

The alert details override settings

alertDetailsOverride?: AlertDetailsOverride

Property Value

alertRuleTemplateName

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

alertRuleTemplateName?: string

Property Value

string

customDetails

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

customDetails?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

description

The description of the alert rule.

description?: string

Property Value

string

displayName

The display name for alerts created by this alert rule.

displayName?: string

Property Value

string

enabled

Determines whether this alert rule is enabled or disabled.

enabled?: boolean

Property Value

boolean

entityMappings

Array of the entity mappings of the alert rule

entityMappings?: EntityMapping[]

Property Value

eventGroupingSettings

The event grouping settings.

eventGroupingSettings?: EventGroupingSettings

Property Value

incidentConfiguration

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

incidentConfiguration?: IncidentConfiguration

Property Value

kind

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

kind: "Scheduled"

Property Value

"Scheduled"

lastModifiedUtc

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.

lastModifiedUtc?: Date

Property Value

Date

query

The query that creates alerts for this rule.

query?: string

Property Value

string

queryFrequency

The frequency (in ISO 8601 duration format) for this alert rule to run.

queryFrequency?: string

Property Value

string

queryPeriod

The period (in ISO 8601 duration format) that this alert rule looks at.

queryPeriod?: string

Property Value

string

severity

The severity for alerts created by this alert rule.

severity?: string

Property Value

string

suppressionDuration

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

suppressionDuration?: string

Property Value

string

suppressionEnabled

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

suppressionEnabled?: boolean

Property Value

boolean

tactics

The tactics of the alert rule

tactics?: string[]

Property Value

string[]

techniques

The techniques of the alert rule

techniques?: string[]

Property Value

string[]

templateVersion

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>

templateVersion?: string

Property Value

string

triggerOperator

The operation against the threshold that triggers alert rule.

triggerOperator?: TriggerOperator

Property Value

triggerThreshold

The threshold triggers this alert rule.

triggerThreshold?: number

Property Value

number

Inherited Property Details

etag

Etag of the azure resource

etag?: string

Property Value

string

Inherited From AlertRule.etag

id

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.

id?: string

Property Value

string

Inherited From AlertRule.id

name

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

name?: string

Property Value

string

Inherited From AlertRule.name

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.

systemData?: SystemData

Property Value

Inherited From AlertRule.systemData

type

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.

type?: string

Property Value

string

Inherited From AlertRule.type