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 ConditionResponse(val operator: String? = null, val values: List<String>? = null)

condition to trigger an action 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 DetectorResponse(val description: String? = null, val id: String, val imagePaths: List<String>? = null, val name: String? = null, val parameters: Map<String, Any>? = null, val supportedResourceTypes: List<String>? = null)

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 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 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 ThrottlingInformationResponse(val duration: String? = null)

Optional throttling information for the alert rule.