@azure/arm-previewalertrule package

Interfaces

DimensionNameAndValue

Dimension name and value

ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorResponse

Common error response for all Azure Resource Manager APIs to return error details for failed operations.

EvaluatedPeriod

Details of the evaluated period.

Evaluation

An evaluation of the alert rule.

LogAlertRuleCondition

A condition of the scheduled query rule.

LogAlertRuleConditionFailingPeriods

The minimum number of violations required within the selected lookback time window required to raise an alert. Relevant only for rules of the kind LogAlert.

LogAlertRuleCriteria

The rule criteria that defines the conditions of the scheduled query rule.

LogAlertRuleDimension

Dimension splitting and filtering definition

LogAlertRuleProperties

scheduled query rule Definition

LogAlertRuleResource

The scheduled query rule resource.

PreviewAlertRuleManagementClientOptionalParams

Optional parameters for the client.

PreviewAlertRuleOptionalParams

Optional parameters.

PreviewAlertRuleRequest

model interface PreviewAlertRuleRequest

PreviewAlertRuleRequestProperties

model interface PreviewAlertRuleRequestProperties

PreviewAlertRuleResponse

model interface PreviewAlertRuleResponse

RulePreviewResult

A rule preview result containing a dimension combination and an array of evaluations.

Type Aliases

AlertSeverity

Severity of the alert. Should be an integer between [0-4]. Value of 0 is severest. Relevant and required only for rules of the kind LogAlert.
KnownAlertSeverity can be used interchangeably with AlertSeverity, this enum contains the known values that the service supports.

Known values supported by the service

0: 0
1: 1
2: 2
3: 3
4: 4

AlertState

The state of the alert after the evaluation.
KnownAlertState can be used interchangeably with AlertState, this enum contains the known values that the service supports.

Known values supported by the service

NoAlert: NoAlert
Fired: Fired
Firing: Firing
Resolving: Resolving
Resolved: Resolved

AzureSupportedClouds

The supported values for cloud setting as a string literal type

ConditionOperator

The criteria operator. Relevant and required only for rules of the kind LogAlert.
KnownConditionOperator can be used interchangeably with ConditionOperator, this enum contains the known values that the service supports.

Known values supported by the service

Equals: Equals
GreaterThan: GreaterThan
GreaterThanOrEqual: GreaterThanOrEqual
LessThan: LessThan
LessThanOrEqual: LessThanOrEqual
GreaterOrLessThan: GreaterOrLessThan

CriterionType

Specifies the type of threshold criteria
KnownCriterionType can be used interchangeably with CriterionType, this enum contains the known values that the service supports.

Known values supported by the service

StaticThresholdCriterion: StaticThresholdCriterion
DynamicThresholdCriterion: DynamicThresholdCriterion

DimensionOperator

Operator for dimension values
KnownDimensionOperator can be used interchangeably with DimensionOperator, this enum contains the known values that the service supports.

Known values supported by the service

Include: Include
Exclude: Exclude

Kind

Indicates the type of scheduled query rule. The default is LogAlert.
KnownKind can be used interchangeably with Kind, this enum contains the known values that the service supports.

Known values supported by the service

LogAlert: LogAlert
EventLogAlert: EventLogAlert
LogToMetric: LogToMetric

TimeAggregation

Aggregation type. Relevant and required only for rules of the kind LogAlert.
KnownTimeAggregation can be used interchangeably with TimeAggregation, this enum contains the known values that the service supports.

Known values supported by the service

Count: Count
Average: Average
Minimum: Minimum
Maximum: Maximum
Total: Total

Enums

AzureClouds

An enum to describe Azure Cloud environments.

KnownAlertSeverity

Severity of the alert. Should be an integer between [0-4]. Value of 0 is severest. Relevant and required only for rules of the kind LogAlert.

KnownAlertState

The state of the alert after the evaluation.

KnownConditionOperator

The criteria operator. Relevant and required only for rules of the kind LogAlert.

KnownCriterionType

Specifies the type of threshold criteria

KnownDimensionOperator

Operator for dimension values

KnownKind

Indicates the type of scheduled query rule. The default is LogAlert.

KnownTimeAggregation

Aggregation type. Relevant and required only for rules of the kind LogAlert.

KnownVersions

The available API versions.