IScheduledQueryRuleResource Interface

Definition

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.Monitor.ScheduledQueryRule.Models.Api20210801.ScheduledQueryRuleResourceTypeConverter))]
public interface IScheduledQueryRuleResource : Microsoft.Azure.PowerShell.Cmdlets.Monitor.ScheduledQueryRule.Models.Api10.ITrackedResource
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.Monitor.ScheduledQueryRule.Models.Api20210801.ScheduledQueryRuleResourceTypeConverter))>]
type IScheduledQueryRuleResource = interface
    interface IJsonSerializable
    interface ITrackedResource
    interface IResource
Public Interface IScheduledQueryRuleResource
Implements ITrackedResource
Derived
Attributes
Implements

Properties

ActionCustomProperty

The properties of an alert payload.

ActionGroup

Action Group resource Ids to invoke when the alert fires.

AutoMitigate

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.

CheckWorkspaceAlertsStorageConfigured

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.

CreatedWithApiVersion

The api-version used when creating this alert rule

CriterionAllOf

A list of conditions to evaluate against the specified scopes

Description

The description of the scheduled query rule.

DisplayName

The display name of the alert rule

Enabled

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

Etag

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.

EvaluationFrequency

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

Id

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

(Inherited from IResource)
IsLegacyLogAnalyticsRule

True if alert rule is legacy Log Analytic rule

IsWorkspaceAlertsStorageConfigured

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

Kind

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

Location

The geo-location where the resource lives

(Inherited from ITrackedResource)
MuteActionsDuration

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.

Name

The name of the resource

(Inherited from IResource)
OverrideQueryTimeRange

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

Scope

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

Severity

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.

SkipQueryValidation

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.

SystemDataCreatedAt

The timestamp of resource creation (UTC).

SystemDataCreatedBy

The identity that created the resource.

SystemDataCreatedByType

The type of identity that created the resource.

SystemDataLastModifiedAt

The timestamp of resource last modification (UTC)

SystemDataLastModifiedBy

The identity that last modified the resource.

SystemDataLastModifiedByType

The type of identity that last modified the resource.

Tag

Resource tags.

(Inherited from ITrackedResource)
TargetResourceType

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

Type

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

(Inherited from IResource)
WindowSize

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.

Methods

ToJson(JsonObject, SerializationMode) (Inherited from IJsonSerializable)

Applies to