GetScheduledQueryRuleResult

data class GetScheduledQueryRuleResult(val actions: ActionsResponse? = null, val autoMitigate: Boolean? = null, val azureApiVersion: String, val checkWorkspaceAlertsStorageConfigured: Boolean? = null, val createdWithApiVersion: String, val criteria: ScheduledQueryRuleCriteriaResponse, val description: String? = null, val displayName: String? = null, val enabled: Boolean, val etag: String, val evaluationFrequency: String? = null, val id: String, val identity: IdentityResponse? = null, val isLegacyLogAnalyticsRule: Boolean, val isWorkspaceAlertsStorageConfigured: Boolean, val kind: String? = null, val location: String, val muteActionsDuration: String? = null, val name: String, val overrideQueryTimeRange: String? = null, val resolveConfiguration: RuleResolveConfigurationResponse? = null, val scopes: List<String>, val severity: Double? = null, val skipQueryValidation: Boolean? = null, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val targetResourceTypes: List<String>? = null, val type: String, val windowSize: String? = null)

The scheduled query rule resource.

Constructors

Link copied to clipboard
constructor(actions: ActionsResponse? = null, autoMitigate: Boolean? = null, azureApiVersion: String, checkWorkspaceAlertsStorageConfigured: Boolean? = null, createdWithApiVersion: String, criteria: ScheduledQueryRuleCriteriaResponse, description: String? = null, displayName: String? = null, enabled: Boolean, etag: String, evaluationFrequency: String? = null, id: String, identity: IdentityResponse? = null, isLegacyLogAnalyticsRule: Boolean, isWorkspaceAlertsStorageConfigured: Boolean, kind: String? = null, location: String, muteActionsDuration: String? = null, name: String, overrideQueryTimeRange: String? = null, resolveConfiguration: RuleResolveConfigurationResponse? = null, scopes: List<String>, severity: Double? = null, skipQueryValidation: Boolean? = null, systemData: SystemDataResponse, tags: Map<String, String>? = null, targetResourceTypes: List<String>? = null, type: String, windowSize: String? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

Actions to invoke when the alert fires.

Link copied to clipboard
val autoMitigate: Boolean? = null

The flag that indicates whether the alert should be automatically resolved or not. The default is true. Relevant only for rules of the kind LogAlert.

Link copied to clipboard

The Azure API version of the resource.

Link copied to clipboard

The flag which indicates whether this scheduled query rule should be stored in the customer's storage. The default is false. Relevant only for rules of the kind LogAlert.

Link copied to clipboard

The api-version used when creating this alert rule

Link copied to clipboard

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

Link copied to clipboard
val description: String? = null

The description of the scheduled query rule.

Link copied to clipboard
val displayName: String? = null

The display name of the alert rule

Link copied to clipboard

The flag which indicates whether this scheduled query rule is enabled. Value should be true or false

Link copied to clipboard

The etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.

Link copied to clipboard

How often the scheduled query rule is evaluated represented in ISO 8601 duration format. Relevant and required only for rules of the kind LogAlert.

Link copied to clipboard
val id: String

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

Link copied to clipboard

The identity of the resource.

Link copied to clipboard

True if alert rule is legacy Log Analytic rule

Link copied to clipboard

The flag which indicates whether this scheduled query rule has been configured to be stored in the customer's storage. The default is false.

Link copied to clipboard
val kind: String? = null

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

Link copied to clipboard

The geo-location where the resource lives

Link copied to clipboard

Mute actions for the chosen period of time (in ISO 8601 duration format) after the alert is fired. Relevant only for rules of the kind LogAlert.

Link copied to clipboard

The name of the resource

Link copied to clipboard

If specified then overrides the query time range (default is WindowSize*NumberOfEvaluationPeriods). Relevant only for rules of the kind LogAlert.

Link copied to clipboard

Defines the configuration for resolving fired alerts. Relevant only for rules of the kind LogAlert.

Link copied to clipboard

The list of resource id's that this scheduled query rule is scoped to.

Link copied to clipboard
val severity: Double? = null

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.

Link copied to clipboard

The flag which indicates whether the provided query should be validated or not. The default is false. Relevant only for rules of the kind LogAlert.

Link copied to clipboard

SystemData of ScheduledQueryRule.

Link copied to clipboard
val tags: Map<String, String>? = null

Resource tags.

Link copied to clipboard

List of resource type of the target resource(s) on which the alert is created/updated. For example if the scope is a resource group and targetResourceTypes is Microsoft.Compute/virtualMachines, then a different alert will be fired for each virtual machine in the resource group which meet the alert criteria. Relevant only for rules of the kind LogAlert

Link copied to clipboard

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Link copied to clipboard
val windowSize: String? = null

The period of time (in ISO 8601 duration format) on which the Alert query will be executed (bin size). Relevant and required only for rules of the kind LogAlert.