Share via

ScheduledQueryRuleResourceInner Class

  • Reference
Package:
com.azure.resourcemanager.monitor.fluent.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-monitor:2.44.0

public final class ScheduledQueryRuleResourceInner
extends Resource

The scheduled query rule resource.

Constructor Summary

Constructor Description
ScheduledQueryRuleResourceInner()

Creates an instance of ScheduledQueryRuleResourceInner class.

Method Summary

Modifier and Type Method and Description
Actions actions()

Get the actions property: Actions to invoke when the alert fires.
Boolean autoMitigate()

Get the autoMitigate property: The flag that indicates whether the alert should be automatically resolved or not.
Boolean checkWorkspaceAlertsStorageConfigured()

Get the checkWorkspaceAlertsStorageConfigured property: The flag which indicates whether this scheduled query rule should be stored in the customer's storage.
String createdWithApiVersion()

Get the createdWithApiVersion property: The api-version used when creating this alert rule.
ScheduledQueryRuleCriteria criteria()

Get the criteria property: The rule criteria that defines the conditions of the scheduled query rule.
String description()

Get the description property: The description of the scheduled query rule.
String displayName()

Get the displayName property: The display name of the alert rule.
Boolean enabled()

Get the enabled property: The flag which indicates whether this scheduled query rule is enabled.
String etag()

Get the etag property: The etag field is *not* required.
Duration evaluationFrequency()

Get the evaluationFrequency property: How often the scheduled query rule is evaluated represented in ISO 8601 duration format.
static ScheduledQueryRuleResourceInner fromJson(JsonReader jsonReader)

Reads an instance of ScheduledQueryRuleResourceInner from the JsonReader.
String id()

Get the id property: Fully qualified resource Id for the resource.
Boolean isLegacyLogAnalyticsRule()

Get the isLegacyLogAnalyticsRule property: True if alert rule is legacy Log Analytic rule.
Boolean isWorkspaceAlertsStorageConfigured()

Get the isWorkspaceAlertsStorageConfigured property: The flag which indicates whether this scheduled query rule has been configured to be stored in the customer's storage.
Kind kind()

Get the kind property: Indicates the type of scheduled query rule.
Duration muteActionsDuration()

Get the muteActionsDuration property: Mute actions for the chosen period of time (in ISO 8601 duration format) after the alert is fired.
String name()

Get the name property: The name of the resource.
Duration overrideQueryTimeRange()

Get the overrideQueryTimeRange property: If specified then overrides the query time range (default is WindowSize*NumberOfEvaluationPeriods).
List<String> scopes()

Get the scopes property: The list of resource id's that this scheduled query rule is scoped to.
AlertSeverity severity()

Get the severity property: Severity of the alert.
Boolean skipQueryValidation()

Get the skipQueryValidation property: The flag which indicates whether the provided query should be validated or not.
SystemData systemData()

Get the systemData property: SystemData of ScheduledQueryRule.
List<String> targetResourceTypes()

Get the targetResourceTypes property: List of resource type of the target resource(s) on which the alert is created/updated.
JsonWriter toJson(JsonWriter jsonWriter)
String type()

Get the type property: The type of the resource.
void validate()

Validates the instance.
Duration windowSize()

Get the windowSize property: The period of time (in ISO 8601 duration format) on which the Alert query will be executed (bin size).
ScheduledQueryRuleResourceInner withActions(Actions actions)

Set the actions property: Actions to invoke when the alert fires.
ScheduledQueryRuleResourceInner withAutoMitigate(Boolean autoMitigate)

Set the autoMitigate property: The flag that indicates whether the alert should be automatically resolved or not.
ScheduledQueryRuleResourceInner withCheckWorkspaceAlertsStorageConfigured(Boolean checkWorkspaceAlertsStorageConfigured)

Set the checkWorkspaceAlertsStorageConfigured property: The flag which indicates whether this scheduled query rule should be stored in the customer's storage.
ScheduledQueryRuleResourceInner withCriteria(ScheduledQueryRuleCriteria criteria)

Set the criteria property: The rule criteria that defines the conditions of the scheduled query rule.
ScheduledQueryRuleResourceInner withDescription(String description)

Set the description property: The description of the scheduled query rule.
ScheduledQueryRuleResourceInner withDisplayName(String displayName)

Set the displayName property: The display name of the alert rule.
ScheduledQueryRuleResourceInner withEnabled(Boolean enabled)

Set the enabled property: The flag which indicates whether this scheduled query rule is enabled.
ScheduledQueryRuleResourceInner withEvaluationFrequency(Duration evaluationFrequency)

Set the evaluationFrequency property: How often the scheduled query rule is evaluated represented in ISO 8601 duration format.
ScheduledQueryRuleResourceInner withKind(Kind kind)

Set the kind property: Indicates the type of scheduled query rule.
ScheduledQueryRuleResourceInner withLocation(String location)
ScheduledQueryRuleResourceInner withMuteActionsDuration(Duration muteActionsDuration)

Set the muteActionsDuration property: Mute actions for the chosen period of time (in ISO 8601 duration format) after the alert is fired.
ScheduledQueryRuleResourceInner withOverrideQueryTimeRange(Duration overrideQueryTimeRange)

Set the overrideQueryTimeRange property: If specified then overrides the query time range (default is WindowSize*NumberOfEvaluationPeriods).
ScheduledQueryRuleResourceInner withScopes(List<String> scopes)

Set the scopes property: The list of resource id's that this scheduled query rule is scoped to.
ScheduledQueryRuleResourceInner withSeverity(AlertSeverity severity)

Set the severity property: Severity of the alert.
ScheduledQueryRuleResourceInner withSkipQueryValidation(Boolean skipQueryValidation)

Set the skipQueryValidation property: The flag which indicates whether the provided query should be validated or not.
ScheduledQueryRuleResourceInner withTags(Map<String,String> tags)
ScheduledQueryRuleResourceInner withTargetResourceTypes(List<String> targetResourceTypes)

Set the targetResourceTypes property: List of resource type of the target resource(s) on which the alert is created/updated.
ScheduledQueryRuleResourceInner withWindowSize(Duration windowSize)

Set the windowSize property: The period of time (in ISO 8601 duration format) on which the Alert query will be executed (bin size).

Methods inherited from ProxyResource

id name type

Methods inherited from Resource

fromJson location tags toJson withLocation withTags

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

ScheduledQueryRuleResourceInner

public ScheduledQueryRuleResourceInner()

Creates an instance of ScheduledQueryRuleResourceInner class.

Method Details

actions

public Actions actions()

Get the actions property: Actions to invoke when the alert fires.

Returns:

the actions value.

autoMitigate

public Boolean autoMitigate()

Get the autoMitigate property: 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.

Returns:

the autoMitigate value.

checkWorkspaceAlertsStorageConfigured

public Boolean checkWorkspaceAlertsStorageConfigured()

Get the checkWorkspaceAlertsStorageConfigured property: 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.

Returns:

the checkWorkspaceAlertsStorageConfigured value.

createdWithApiVersion

public String createdWithApiVersion()

Get the createdWithApiVersion property: The api-version used when creating this alert rule.

Returns:

the createdWithApiVersion value.

criteria

public ScheduledQueryRuleCriteria criteria()

Get the criteria property: The rule criteria that defines the conditions of the scheduled query rule.

Returns:

the criteria value.

description

public String description()

Get the description property: The description of the scheduled query rule.

Returns:

the description value.

displayName

public String displayName()

Get the displayName property: The display name of the alert rule.

Returns:

the displayName value.

enabled

public Boolean enabled()

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

Returns:

the enabled value.

etag

public String etag()

Get the etag property: 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.

Returns:

the etag value.

evaluationFrequency

public Duration evaluationFrequency()

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

Returns:

the evaluationFrequency value.

fromJson

public static ScheduledQueryRuleResourceInner fromJson(JsonReader jsonReader)

Reads an instance of ScheduledQueryRuleResourceInner from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of ScheduledQueryRuleResourceInner if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

 - If the deserialized JSON object was missing any required properties.

id

public String id()

Get the id property: Fully qualified resource Id for the resource.

Overrides:

ScheduledQueryRuleResourceInner.id()

Returns:

the id value.

isLegacyLogAnalyticsRule

public Boolean isLegacyLogAnalyticsRule()

Get the isLegacyLogAnalyticsRule property: True if alert rule is legacy Log Analytic rule.

Returns:

the isLegacyLogAnalyticsRule value.

isWorkspaceAlertsStorageConfigured

public Boolean isWorkspaceAlertsStorageConfigured()

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

Returns:

the isWorkspaceAlertsStorageConfigured value.

kind

public Kind kind()

Get the kind property: Indicates the type of scheduled query rule. The default is LogAlert.

Returns:

the kind value.

muteActionsDuration

public Duration muteActionsDuration()

Get the muteActionsDuration property: 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.

Returns:

the muteActionsDuration value.

name

public String name()

Get the name property: The name of the resource.

Overrides:

ScheduledQueryRuleResourceInner.name()

Returns:

the name value.

overrideQueryTimeRange

public Duration overrideQueryTimeRange()

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

Returns:

the overrideQueryTimeRange value.

scopes

public List scopes()

Get the scopes property: The list of resource id's that this scheduled query rule is scoped to.

Returns:

the scopes value.

severity

public AlertSeverity severity()

Get the severity property: 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.

Returns:

the severity value.

skipQueryValidation

public Boolean skipQueryValidation()

Get the skipQueryValidation property: 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.

Returns:

the skipQueryValidation value.

systemData

public SystemData systemData()

Get the systemData property: SystemData of ScheduledQueryRule.

Returns:

the systemData value.

targetResourceTypes

public List targetResourceTypes()

Get the targetResourceTypes property: 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.

Returns:

the targetResourceTypes value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

ScheduledQueryRuleResourceInner.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

type

public String type()

Get the type property: The type of the resource.

Overrides:

ScheduledQueryRuleResourceInner.type()

Returns:

the type value.

validate

public void validate()

Validates the instance.

windowSize

public Duration windowSize()

Get the windowSize property: 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.

Returns:

the windowSize value.

withActions

public ScheduledQueryRuleResourceInner withActions(Actions actions)

Set the actions property: Actions to invoke when the alert fires.

Parameters:

actions - the actions value to set.

Returns:

the ScheduledQueryRuleResourceInner object itself.

withAutoMitigate

public ScheduledQueryRuleResourceInner withAutoMitigate(Boolean autoMitigate)

Set the autoMitigate property: 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.

Parameters:

autoMitigate - the autoMitigate value to set.

Returns:

the ScheduledQueryRuleResourceInner object itself.

withCheckWorkspaceAlertsStorageConfigured

public ScheduledQueryRuleResourceInner withCheckWorkspaceAlertsStorageConfigured(Boolean checkWorkspaceAlertsStorageConfigured)

Set the checkWorkspaceAlertsStorageConfigured property: 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.

Parameters:

checkWorkspaceAlertsStorageConfigured - the checkWorkspaceAlertsStorageConfigured value to set.

Returns:

the ScheduledQueryRuleResourceInner object itself.

withCriteria

public ScheduledQueryRuleResourceInner withCriteria(ScheduledQueryRuleCriteria criteria)

Set the criteria property: The rule criteria that defines the conditions of the scheduled query rule.

Parameters:

criteria - the criteria value to set.

Returns:

the ScheduledQueryRuleResourceInner object itself.

withDescription

public ScheduledQueryRuleResourceInner withDescription(String description)

Set the description property: The description of the scheduled query rule.

Parameters:

description - the description value to set.

Returns:

the ScheduledQueryRuleResourceInner object itself.

withDisplayName

public ScheduledQueryRuleResourceInner withDisplayName(String displayName)

Set the displayName property: The display name of the alert rule.

Parameters:

displayName - the displayName value to set.

Returns:

the ScheduledQueryRuleResourceInner object itself.

withEnabled

public ScheduledQueryRuleResourceInner withEnabled(Boolean enabled)

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

Parameters:

enabled - the enabled value to set.

Returns:

the ScheduledQueryRuleResourceInner object itself.

withEvaluationFrequency

public ScheduledQueryRuleResourceInner withEvaluationFrequency(Duration evaluationFrequency)

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

Parameters:

evaluationFrequency - the evaluationFrequency value to set.

Returns:

the ScheduledQueryRuleResourceInner object itself.

withKind

public ScheduledQueryRuleResourceInner withKind(Kind kind)

Set the kind property: Indicates the type of scheduled query rule. The default is LogAlert.

Parameters:

kind - the kind value to set.

Returns:

the ScheduledQueryRuleResourceInner object itself.

withLocation

public ScheduledQueryRuleResourceInner withLocation(String location)

Overrides:

ScheduledQueryRuleResourceInner.withLocation(String location)

Parameters:

location

withMuteActionsDuration

public ScheduledQueryRuleResourceInner withMuteActionsDuration(Duration muteActionsDuration)

Set the muteActionsDuration property: 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.

Parameters:

muteActionsDuration - the muteActionsDuration value to set.

Returns:

the ScheduledQueryRuleResourceInner object itself.

withOverrideQueryTimeRange

public ScheduledQueryRuleResourceInner withOverrideQueryTimeRange(Duration overrideQueryTimeRange)

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

Parameters:

overrideQueryTimeRange - the overrideQueryTimeRange value to set.

Returns:

the ScheduledQueryRuleResourceInner object itself.

withScopes

public ScheduledQueryRuleResourceInner withScopes(List scopes)

Set the scopes property: The list of resource id's that this scheduled query rule is scoped to.

Parameters:

scopes - the scopes value to set.

Returns:

the ScheduledQueryRuleResourceInner object itself.

withSeverity

public ScheduledQueryRuleResourceInner withSeverity(AlertSeverity severity)

Set the severity property: 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.

Parameters:

severity - the severity value to set.

Returns:

the ScheduledQueryRuleResourceInner object itself.

withSkipQueryValidation

public ScheduledQueryRuleResourceInner withSkipQueryValidation(Boolean skipQueryValidation)

Set the skipQueryValidation property: 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.

Parameters:

skipQueryValidation - the skipQueryValidation value to set.

Returns:

the ScheduledQueryRuleResourceInner object itself.

withTags

public ScheduledQueryRuleResourceInner withTags(Map tags)

Overrides:

ScheduledQueryRuleResourceInner.withTags(Map<String,String> tags)

Parameters:

tags

withTargetResourceTypes

public ScheduledQueryRuleResourceInner withTargetResourceTypes(List targetResourceTypes)

Set the targetResourceTypes property: 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.

Parameters:

targetResourceTypes - the targetResourceTypes value to set.

Returns:

the ScheduledQueryRuleResourceInner object itself.

withWindowSize

public ScheduledQueryRuleResourceInner withWindowSize(Duration windowSize)

Set the windowSize property: 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.

Parameters:

windowSize - the windowSize value to set.

Returns:

the ScheduledQueryRuleResourceInner object itself.

Applies to