com.pulumi.azurenative.insights.ScheduledQueryRuleArgs Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of azure-native Show documentation
Show all versions of azure-native Show documentation
A native Pulumi package for creating and managing Azure resources.
// *** WARNING: this file was generated by pulumi-java-gen. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
package com.pulumi.azurenative.insights;
import com.pulumi.azurenative.insights.enums.Kind;
import com.pulumi.azurenative.insights.inputs.ActionsArgs;
import com.pulumi.azurenative.insights.inputs.IdentityArgs;
import com.pulumi.azurenative.insights.inputs.RuleResolveConfigurationArgs;
import com.pulumi.azurenative.insights.inputs.ScheduledQueryRuleCriteriaArgs;
import com.pulumi.core.Either;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Import;
import com.pulumi.exceptions.MissingRequiredPropertyException;
import java.lang.Boolean;
import java.lang.Double;
import java.lang.String;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import javax.annotation.Nullable;
public final class ScheduledQueryRuleArgs extends com.pulumi.resources.ResourceArgs {
public static final ScheduledQueryRuleArgs Empty = new ScheduledQueryRuleArgs();
/**
* Actions to invoke when the alert fires.
*
*/
@Import(name="actions")
private @Nullable Output actions;
/**
* @return Actions to invoke when the alert fires.
*
*/
public Optional> actions() {
return Optional.ofNullable(this.actions);
}
/**
* 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.
*
*/
@Import(name="autoMitigate")
private @Nullable Output autoMitigate;
/**
* @return 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.
*
*/
public Optional> autoMitigate() {
return Optional.ofNullable(this.autoMitigate);
}
/**
* 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.
*
*/
@Import(name="checkWorkspaceAlertsStorageConfigured")
private @Nullable Output checkWorkspaceAlertsStorageConfigured;
/**
* @return 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.
*
*/
public Optional> checkWorkspaceAlertsStorageConfigured() {
return Optional.ofNullable(this.checkWorkspaceAlertsStorageConfigured);
}
/**
* The rule criteria that defines the conditions of the scheduled query rule.
*
*/
@Import(name="criteria", required=true)
private Output criteria;
/**
* @return The rule criteria that defines the conditions of the scheduled query rule.
*
*/
public Output criteria() {
return this.criteria;
}
/**
* The description of the scheduled query rule.
*
*/
@Import(name="description")
private @Nullable Output description;
/**
* @return The description of the scheduled query rule.
*
*/
public Optional> description() {
return Optional.ofNullable(this.description);
}
/**
* The display name of the alert rule
*
*/
@Import(name="displayName")
private @Nullable Output displayName;
/**
* @return The display name of the alert rule
*
*/
public Optional> displayName() {
return Optional.ofNullable(this.displayName);
}
/**
* The flag which indicates whether this scheduled query rule is enabled. Value should be true or false
*
*/
@Import(name="enabled", required=true)
private Output enabled;
/**
* @return The flag which indicates whether this scheduled query rule is enabled. Value should be true or false
*
*/
public Output enabled() {
return this.enabled;
}
/**
* How often the scheduled query rule is evaluated represented in ISO 8601 duration format. Relevant and required only for rules of the kind LogAlert.
*
*/
@Import(name="evaluationFrequency")
private @Nullable Output evaluationFrequency;
/**
* @return How often the scheduled query rule is evaluated represented in ISO 8601 duration format. Relevant and required only for rules of the kind LogAlert.
*
*/
public Optional> evaluationFrequency() {
return Optional.ofNullable(this.evaluationFrequency);
}
/**
* The identity of the resource.
*
*/
@Import(name="identity")
private @Nullable Output identity;
/**
* @return The identity of the resource.
*
*/
public Optional> identity() {
return Optional.ofNullable(this.identity);
}
/**
* Indicates the type of scheduled query rule. The default is LogAlert.
*
*/
@Import(name="kind")
private @Nullable Output> kind;
/**
* @return Indicates the type of scheduled query rule. The default is LogAlert.
*
*/
public Optional>> kind() {
return Optional.ofNullable(this.kind);
}
/**
* The geo-location where the resource lives
*
*/
@Import(name="location")
private @Nullable Output location;
/**
* @return The geo-location where the resource lives
*
*/
public Optional> location() {
return Optional.ofNullable(this.location);
}
/**
* 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.
*
*/
@Import(name="muteActionsDuration")
private @Nullable Output muteActionsDuration;
/**
* @return 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.
*
*/
public Optional> muteActionsDuration() {
return Optional.ofNullable(this.muteActionsDuration);
}
/**
* If specified then overrides the query time range (default is WindowSize*NumberOfEvaluationPeriods). Relevant only for rules of the kind LogAlert.
*
*/
@Import(name="overrideQueryTimeRange")
private @Nullable Output overrideQueryTimeRange;
/**
* @return If specified then overrides the query time range (default is WindowSize*NumberOfEvaluationPeriods). Relevant only for rules of the kind LogAlert.
*
*/
public Optional> overrideQueryTimeRange() {
return Optional.ofNullable(this.overrideQueryTimeRange);
}
/**
* The name of the resource group. The name is case insensitive.
*
*/
@Import(name="resourceGroupName", required=true)
private Output resourceGroupName;
/**
* @return The name of the resource group. The name is case insensitive.
*
*/
public Output resourceGroupName() {
return this.resourceGroupName;
}
/**
* The name of the rule.
*
*/
@Import(name="ruleName")
private @Nullable Output ruleName;
/**
* @return The name of the rule.
*
*/
public Optional> ruleName() {
return Optional.ofNullable(this.ruleName);
}
/**
* Defines the configuration for resolving fired alerts. Relevant only for rules of the kind LogAlert.
*
*/
@Import(name="ruleResolveConfiguration")
private @Nullable Output ruleResolveConfiguration;
/**
* @return Defines the configuration for resolving fired alerts. Relevant only for rules of the kind LogAlert.
*
*/
public Optional> ruleResolveConfiguration() {
return Optional.ofNullable(this.ruleResolveConfiguration);
}
/**
* The list of resource id's that this scheduled query rule is scoped to.
*
*/
@Import(name="scopes", required=true)
private Output> scopes;
/**
* @return The list of resource id's that this scheduled query rule is scoped to.
*
*/
public Output> scopes() {
return this.scopes;
}
/**
* 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.
*
*/
@Import(name="severity")
private @Nullable Output severity;
/**
* @return 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.
*
*/
public Optional> severity() {
return Optional.ofNullable(this.severity);
}
/**
* 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.
*
*/
@Import(name="skipQueryValidation")
private @Nullable Output skipQueryValidation;
/**
* @return 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.
*
*/
public Optional> skipQueryValidation() {
return Optional.ofNullable(this.skipQueryValidation);
}
/**
* Resource tags.
*
*/
@Import(name="tags")
private @Nullable Output> tags;
/**
* @return Resource tags.
*
*/
public Optional>> tags() {
return Optional.ofNullable(this.tags);
}
/**
* 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
*
*/
@Import(name="targetResourceTypes")
private @Nullable Output> targetResourceTypes;
/**
* @return 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
*
*/
public Optional>> targetResourceTypes() {
return Optional.ofNullable(this.targetResourceTypes);
}
/**
* 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.
*
*/
@Import(name="windowSize")
private @Nullable Output windowSize;
/**
* @return 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.
*
*/
public Optional> windowSize() {
return Optional.ofNullable(this.windowSize);
}
private ScheduledQueryRuleArgs() {}
private ScheduledQueryRuleArgs(ScheduledQueryRuleArgs $) {
this.actions = $.actions;
this.autoMitigate = $.autoMitigate;
this.checkWorkspaceAlertsStorageConfigured = $.checkWorkspaceAlertsStorageConfigured;
this.criteria = $.criteria;
this.description = $.description;
this.displayName = $.displayName;
this.enabled = $.enabled;
this.evaluationFrequency = $.evaluationFrequency;
this.identity = $.identity;
this.kind = $.kind;
this.location = $.location;
this.muteActionsDuration = $.muteActionsDuration;
this.overrideQueryTimeRange = $.overrideQueryTimeRange;
this.resourceGroupName = $.resourceGroupName;
this.ruleName = $.ruleName;
this.ruleResolveConfiguration = $.ruleResolveConfiguration;
this.scopes = $.scopes;
this.severity = $.severity;
this.skipQueryValidation = $.skipQueryValidation;
this.tags = $.tags;
this.targetResourceTypes = $.targetResourceTypes;
this.windowSize = $.windowSize;
}
public static Builder builder() {
return new Builder();
}
public static Builder builder(ScheduledQueryRuleArgs defaults) {
return new Builder(defaults);
}
public static final class Builder {
private ScheduledQueryRuleArgs $;
public Builder() {
$ = new ScheduledQueryRuleArgs();
}
public Builder(ScheduledQueryRuleArgs defaults) {
$ = new ScheduledQueryRuleArgs(Objects.requireNonNull(defaults));
}
/**
* @param actions Actions to invoke when the alert fires.
*
* @return builder
*
*/
public Builder actions(@Nullable Output actions) {
$.actions = actions;
return this;
}
/**
* @param actions Actions to invoke when the alert fires.
*
* @return builder
*
*/
public Builder actions(ActionsArgs actions) {
return actions(Output.of(actions));
}
/**
* @param 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.
*
* @return builder
*
*/
public Builder autoMitigate(@Nullable Output autoMitigate) {
$.autoMitigate = autoMitigate;
return this;
}
/**
* @param 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.
*
* @return builder
*
*/
public Builder autoMitigate(Boolean autoMitigate) {
return autoMitigate(Output.of(autoMitigate));
}
/**
* @param 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.
*
* @return builder
*
*/
public Builder checkWorkspaceAlertsStorageConfigured(@Nullable Output checkWorkspaceAlertsStorageConfigured) {
$.checkWorkspaceAlertsStorageConfigured = checkWorkspaceAlertsStorageConfigured;
return this;
}
/**
* @param 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.
*
* @return builder
*
*/
public Builder checkWorkspaceAlertsStorageConfigured(Boolean checkWorkspaceAlertsStorageConfigured) {
return checkWorkspaceAlertsStorageConfigured(Output.of(checkWorkspaceAlertsStorageConfigured));
}
/**
* @param criteria The rule criteria that defines the conditions of the scheduled query rule.
*
* @return builder
*
*/
public Builder criteria(Output criteria) {
$.criteria = criteria;
return this;
}
/**
* @param criteria The rule criteria that defines the conditions of the scheduled query rule.
*
* @return builder
*
*/
public Builder criteria(ScheduledQueryRuleCriteriaArgs criteria) {
return criteria(Output.of(criteria));
}
/**
* @param description The description of the scheduled query rule.
*
* @return builder
*
*/
public Builder description(@Nullable Output description) {
$.description = description;
return this;
}
/**
* @param description The description of the scheduled query rule.
*
* @return builder
*
*/
public Builder description(String description) {
return description(Output.of(description));
}
/**
* @param displayName The display name of the alert rule
*
* @return builder
*
*/
public Builder displayName(@Nullable Output displayName) {
$.displayName = displayName;
return this;
}
/**
* @param displayName The display name of the alert rule
*
* @return builder
*
*/
public Builder displayName(String displayName) {
return displayName(Output.of(displayName));
}
/**
* @param enabled The flag which indicates whether this scheduled query rule is enabled. Value should be true or false
*
* @return builder
*
*/
public Builder enabled(Output enabled) {
$.enabled = enabled;
return this;
}
/**
* @param enabled The flag which indicates whether this scheduled query rule is enabled. Value should be true or false
*
* @return builder
*
*/
public Builder enabled(Boolean enabled) {
return enabled(Output.of(enabled));
}
/**
* @param 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.
*
* @return builder
*
*/
public Builder evaluationFrequency(@Nullable Output evaluationFrequency) {
$.evaluationFrequency = evaluationFrequency;
return this;
}
/**
* @param 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.
*
* @return builder
*
*/
public Builder evaluationFrequency(String evaluationFrequency) {
return evaluationFrequency(Output.of(evaluationFrequency));
}
/**
* @param identity The identity of the resource.
*
* @return builder
*
*/
public Builder identity(@Nullable Output identity) {
$.identity = identity;
return this;
}
/**
* @param identity The identity of the resource.
*
* @return builder
*
*/
public Builder identity(IdentityArgs identity) {
return identity(Output.of(identity));
}
/**
* @param kind Indicates the type of scheduled query rule. The default is LogAlert.
*
* @return builder
*
*/
public Builder kind(@Nullable Output> kind) {
$.kind = kind;
return this;
}
/**
* @param kind Indicates the type of scheduled query rule. The default is LogAlert.
*
* @return builder
*
*/
public Builder kind(Either kind) {
return kind(Output.of(kind));
}
/**
* @param kind Indicates the type of scheduled query rule. The default is LogAlert.
*
* @return builder
*
*/
public Builder kind(String kind) {
return kind(Either.ofLeft(kind));
}
/**
* @param kind Indicates the type of scheduled query rule. The default is LogAlert.
*
* @return builder
*
*/
public Builder kind(Kind kind) {
return kind(Either.ofRight(kind));
}
/**
* @param location The geo-location where the resource lives
*
* @return builder
*
*/
public Builder location(@Nullable Output location) {
$.location = location;
return this;
}
/**
* @param location The geo-location where the resource lives
*
* @return builder
*
*/
public Builder location(String location) {
return location(Output.of(location));
}
/**
* @param 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.
*
* @return builder
*
*/
public Builder muteActionsDuration(@Nullable Output muteActionsDuration) {
$.muteActionsDuration = muteActionsDuration;
return this;
}
/**
* @param 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.
*
* @return builder
*
*/
public Builder muteActionsDuration(String muteActionsDuration) {
return muteActionsDuration(Output.of(muteActionsDuration));
}
/**
* @param overrideQueryTimeRange If specified then overrides the query time range (default is WindowSize*NumberOfEvaluationPeriods). Relevant only for rules of the kind LogAlert.
*
* @return builder
*
*/
public Builder overrideQueryTimeRange(@Nullable Output overrideQueryTimeRange) {
$.overrideQueryTimeRange = overrideQueryTimeRange;
return this;
}
/**
* @param overrideQueryTimeRange If specified then overrides the query time range (default is WindowSize*NumberOfEvaluationPeriods). Relevant only for rules of the kind LogAlert.
*
* @return builder
*
*/
public Builder overrideQueryTimeRange(String overrideQueryTimeRange) {
return overrideQueryTimeRange(Output.of(overrideQueryTimeRange));
}
/**
* @param resourceGroupName The name of the resource group. The name is case insensitive.
*
* @return builder
*
*/
public Builder resourceGroupName(Output resourceGroupName) {
$.resourceGroupName = resourceGroupName;
return this;
}
/**
* @param resourceGroupName The name of the resource group. The name is case insensitive.
*
* @return builder
*
*/
public Builder resourceGroupName(String resourceGroupName) {
return resourceGroupName(Output.of(resourceGroupName));
}
/**
* @param ruleName The name of the rule.
*
* @return builder
*
*/
public Builder ruleName(@Nullable Output ruleName) {
$.ruleName = ruleName;
return this;
}
/**
* @param ruleName The name of the rule.
*
* @return builder
*
*/
public Builder ruleName(String ruleName) {
return ruleName(Output.of(ruleName));
}
/**
* @param ruleResolveConfiguration Defines the configuration for resolving fired alerts. Relevant only for rules of the kind LogAlert.
*
* @return builder
*
*/
public Builder ruleResolveConfiguration(@Nullable Output ruleResolveConfiguration) {
$.ruleResolveConfiguration = ruleResolveConfiguration;
return this;
}
/**
* @param ruleResolveConfiguration Defines the configuration for resolving fired alerts. Relevant only for rules of the kind LogAlert.
*
* @return builder
*
*/
public Builder ruleResolveConfiguration(RuleResolveConfigurationArgs ruleResolveConfiguration) {
return ruleResolveConfiguration(Output.of(ruleResolveConfiguration));
}
/**
* @param scopes The list of resource id's that this scheduled query rule is scoped to.
*
* @return builder
*
*/
public Builder scopes(Output> scopes) {
$.scopes = scopes;
return this;
}
/**
* @param scopes The list of resource id's that this scheduled query rule is scoped to.
*
* @return builder
*
*/
public Builder scopes(List scopes) {
return scopes(Output.of(scopes));
}
/**
* @param scopes The list of resource id's that this scheduled query rule is scoped to.
*
* @return builder
*
*/
public Builder scopes(String... scopes) {
return scopes(List.of(scopes));
}
/**
* @param 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.
*
* @return builder
*
*/
public Builder severity(@Nullable Output severity) {
$.severity = severity;
return this;
}
/**
* @param 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.
*
* @return builder
*
*/
public Builder severity(Double severity) {
return severity(Output.of(severity));
}
/**
* @param 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.
*
* @return builder
*
*/
public Builder skipQueryValidation(@Nullable Output skipQueryValidation) {
$.skipQueryValidation = skipQueryValidation;
return this;
}
/**
* @param 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.
*
* @return builder
*
*/
public Builder skipQueryValidation(Boolean skipQueryValidation) {
return skipQueryValidation(Output.of(skipQueryValidation));
}
/**
* @param tags Resource tags.
*
* @return builder
*
*/
public Builder tags(@Nullable Output> tags) {
$.tags = tags;
return this;
}
/**
* @param tags Resource tags.
*
* @return builder
*
*/
public Builder tags(Map tags) {
return tags(Output.of(tags));
}
/**
* @param targetResourceTypes 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
*
* @return builder
*
*/
public Builder targetResourceTypes(@Nullable Output> targetResourceTypes) {
$.targetResourceTypes = targetResourceTypes;
return this;
}
/**
* @param targetResourceTypes 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
*
* @return builder
*
*/
public Builder targetResourceTypes(List targetResourceTypes) {
return targetResourceTypes(Output.of(targetResourceTypes));
}
/**
* @param targetResourceTypes 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
*
* @return builder
*
*/
public Builder targetResourceTypes(String... targetResourceTypes) {
return targetResourceTypes(List.of(targetResourceTypes));
}
/**
* @param 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.
*
* @return builder
*
*/
public Builder windowSize(@Nullable Output windowSize) {
$.windowSize = windowSize;
return this;
}
/**
* @param 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.
*
* @return builder
*
*/
public Builder windowSize(String windowSize) {
return windowSize(Output.of(windowSize));
}
public ScheduledQueryRuleArgs build() {
if ($.criteria == null) {
throw new MissingRequiredPropertyException("ScheduledQueryRuleArgs", "criteria");
}
if ($.enabled == null) {
throw new MissingRequiredPropertyException("ScheduledQueryRuleArgs", "enabled");
}
if ($.resourceGroupName == null) {
throw new MissingRequiredPropertyException("ScheduledQueryRuleArgs", "resourceGroupName");
}
if ($.scopes == null) {
throw new MissingRequiredPropertyException("ScheduledQueryRuleArgs", "scopes");
}
return $;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy