Package-level declarations

Types

Link copied to clipboard
data class ActionGroupResponse(val actionGroupId: String, val conditions: ConditionsResponse? = null, val createdAt: String, val createdBy: String, val description: String? = null, val lastModifiedAt: String, val lastModifiedBy: String, val scope: ScopeResponse? = null, val status: String? = null, val type: String)

Action rule with action group configuration

Link copied to clipboard
data class ActionGroupsInformationResponse(val customEmailSubject: String? = null, val customWebhookPayload: String? = null, val groupIds: List<String>)

The Action Groups information, used by the alert rule.

Link copied to clipboard
data class AddActionGroupsResponse(val actionGroupIds: List<String>, val actionType: String)

Add action groups to alert processing rule.

Link copied to clipboard
data class AlertProcessingRulePropertiesResponse(val actions: List<Either<AddActionGroupsResponse, RemoveAllActionGroupsResponse>>, val conditions: List<ConditionResponse>? = null, val description: String? = null, val enabled: Boolean? = null, val schedule: ScheduleResponse? = null, val scopes: List<String>)

Alert processing rule properties defining scopes, conditions and scheduling logic for alert processing rule.

Link copied to clipboard
data class ConditionResponse(val field: String? = null, val operator: String? = null, val values: List<String>? = null)

Condition to trigger an alert processing rule.

Link copied to clipboard
data class ConditionsResponse(val alertContext: ConditionResponse? = null, val alertRuleId: ConditionResponse? = null, val alertRuleName: ConditionResponse? = null, val description: ConditionResponse? = null, val monitorCondition: ConditionResponse? = null, val monitorService: ConditionResponse? = null, val severity: ConditionResponse? = null, val targetResourceType: ConditionResponse? = null)

Conditions in alert instance to be matched for a given action rule. Default value is all. Multiple values could be provided with comma separation.

Link copied to clipboard
data class DailyRecurrenceResponse(val endTime: String, val recurrenceType: String, val startTime: String)

Daily recurrence object.

Link copied to clipboard
data class DetectorParameterDefinitionResponse(val description: String? = null, val displayName: String? = null, val isMandatory: Boolean? = null, val name: String? = null, val type: String? = null)

The detector parameter definition.

Link copied to clipboard
data class DetectorResponse(val description: String, val id: String, val imagePaths: List<String>, val name: String, val parameterDefinitions: List<DetectorParameterDefinitionResponse>, val parameters: Map<String, Any>? = null, val supportedCadences: List<Int>, val supportedResourceTypes: List<String>)

The detector information. By default this is not populated, unless it's specified in expandDetector

Link copied to clipboard
data class DiagnosticsResponse(val conditions: ConditionsResponse? = null, val createdAt: String, val createdBy: String, val description: String? = null, val lastModifiedAt: String, val lastModifiedBy: String, val scope: ScopeResponse? = null, val status: String? = null, val type: String)

Action rule with diagnostics configuration

Link copied to clipboard
data class GetActionRuleByNameResult(val id: String, val location: String, val name: String, val properties: Any, val tags: Map<String, String>? = null, val type: String)

Action rule object containing target scope, conditions and suppression logic

Link copied to clipboard
data class GetAlertProcessingRuleByNameResult(val id: String, val location: String, val name: String, val properties: AlertProcessingRulePropertiesResponse, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

Alert processing rule object containing target scopes, conditions and scheduling logic.

Link copied to clipboard
data class GetPrometheusRuleGroupResult(val clusterName: String? = null, val description: String? = null, val enabled: Boolean? = null, val id: String, val interval: String? = null, val location: String, val name: String, val rules: List<PrometheusRuleResponse>, val scopes: List<String>, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

The Prometheus rule group resource.

Link copied to clipboard
data class GetSmartDetectorAlertRuleResult(val actionGroups: ActionGroupsInformationResponse, val description: String? = null, val detector: DetectorResponse, val frequency: String, val id: String, val location: String? = null, val name: String, val scope: List<String>, val severity: String, val state: String, val tags: Map<String, String>? = null, val throttling: ThrottlingInformationResponse? = null, val type: String)

The alert rule information

Link copied to clipboard
data class MonthlyRecurrenceResponse(val daysOfMonth: List<Int>, val endTime: String? = null, val recurrenceType: String, val startTime: String? = null)

Monthly recurrence object.

Link copied to clipboard
data class PrometheusRuleGroupActionResponse(val actionGroupId: String? = null, val actionProperties: Map<String, String>? = null)

An alert action. Only relevant for alerts.

data class PrometheusRuleResolveConfigurationResponse(val autoResolved: Boolean? = null, val timeToResolve: String? = null)

Specifies the Prometheus alert rule configuration.

Link copied to clipboard
data class PrometheusRuleResponse(val actions: List<PrometheusRuleGroupActionResponse>? = null, val alert: String? = null, val annotations: Map<String, String>? = null, val enabled: Boolean? = null, val expression: String, val for: String? = null, val labels: Map<String, String>? = null, val record: String? = null, val resolveConfiguration: PrometheusRuleResolveConfigurationResponse? = null, val severity: Int? = null)

An Azure Prometheus alerting or recording rule.

Link copied to clipboard
data class RemoveAllActionGroupsResponse(val actionType: String)

Indicates if all action groups should be removed.

Link copied to clipboard
data class ScheduleResponse(val effectiveFrom: String? = null, val effectiveUntil: String? = null, val recurrences: List<Any>? = null, val timeZone: String? = null)

Scheduling configuration for a given alert processing rule.

Link copied to clipboard
data class ScopeResponse(val scopeType: String? = null, val values: List<String>? = null)

Target scope for a given action rule. By default scope will be the subscription. User can also provide list of resource groups or list of resources from the scope subscription as well.

Link copied to clipboard
data class SuppressionConfigResponse(val recurrenceType: String, val schedule: SuppressionScheduleResponse? = null)

Suppression logic for a given action rule

Link copied to clipboard
data class SuppressionResponse(val conditions: ConditionsResponse? = null, val createdAt: String, val createdBy: String, val description: String? = null, val lastModifiedAt: String, val lastModifiedBy: String, val scope: ScopeResponse? = null, val status: String? = null, val suppressionConfig: SuppressionConfigResponse, val type: String)

Action rule with suppression configuration

Link copied to clipboard
data class SuppressionScheduleResponse(val endDate: String? = null, val endTime: String? = null, val recurrenceValues: List<Int>? = null, val startDate: String? = null, val startTime: String? = null)

Schedule for a given suppression configuration.

Link copied to clipboard
data class SystemDataResponse(val createdAt: String? = null, val createdBy: String? = null, val createdByType: String? = null, val lastModifiedAt: String? = null, val lastModifiedBy: String? = null, val lastModifiedByType: String? = null)

Metadata pertaining to creation and last modification of the resource.

Link copied to clipboard
data class ThrottlingInformationResponse(val duration: String? = null)

Optional throttling information for the alert rule.

Link copied to clipboard
data class WeeklyRecurrenceResponse(val daysOfWeek: List<String>, val endTime: String? = null, val recurrenceType: String, val startTime: String? = null)

Weekly recurrence object.