@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 9.01 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
import * as enums from "../types/enums";
/**
* Represents scheduled alert rule.
*
* Uses Azure REST API version 2024-09-01. In version 2.x of the Azure Native provider, it used API version 2023-02-01.
*/
export declare class ScheduledAlertRule extends pulumi.CustomResource {
/**
* Get an existing ScheduledAlertRule resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): ScheduledAlertRule;
/**
* Returns true if the given object is an instance of ScheduledAlertRule. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is ScheduledAlertRule;
/**
* The alert details override settings
*/
readonly alertDetailsOverride: pulumi.Output<outputs.securityinsights.AlertDetailsOverrideResponse | undefined>;
/**
* The Name of the alert rule template used to create this rule.
*/
readonly alertRuleTemplateName: pulumi.Output<string | undefined>;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: pulumi.Output<string>;
/**
* Dictionary of string key-value pairs of columns to be attached to the alert
*/
readonly customDetails: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* The description of the alert rule.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* The display name for alerts created by this alert rule.
*/
readonly displayName: pulumi.Output<string>;
/**
* Determines whether this alert rule is enabled or disabled.
*/
readonly enabled: pulumi.Output<boolean>;
/**
* Array of the entity mappings of the alert rule
*/
readonly entityMappings: pulumi.Output<outputs.securityinsights.EntityMappingResponse[] | undefined>;
/**
* Etag of the azure resource
*/
readonly etag: pulumi.Output<string | undefined>;
/**
* The event grouping settings.
*/
readonly eventGroupingSettings: pulumi.Output<outputs.securityinsights.EventGroupingSettingsResponse | undefined>;
/**
* The settings of the incidents that created from alerts triggered by this analytics rule
*/
readonly incidentConfiguration: pulumi.Output<outputs.securityinsights.IncidentConfigurationResponse | undefined>;
/**
* The kind of the alert rule
* Expected value is 'Scheduled'.
*/
readonly kind: pulumi.Output<"Scheduled">;
/**
* The last time that this alert rule has been modified.
*/
readonly lastModifiedUtc: pulumi.Output<string>;
/**
* The name of the resource
*/
readonly name: pulumi.Output<string>;
/**
* The query that creates alerts for this rule.
*/
readonly query: pulumi.Output<string>;
/**
* The frequency (in ISO 8601 duration format) for this alert rule to run.
*/
readonly queryFrequency: pulumi.Output<string>;
/**
* The period (in ISO 8601 duration format) that this alert rule looks at.
*/
readonly queryPeriod: pulumi.Output<string>;
/**
* The severity for alerts created by this alert rule.
*/
readonly severity: pulumi.Output<string>;
/**
* The suppression (in ISO 8601 duration format) to wait since last time this alert rule been triggered.
*/
readonly suppressionDuration: pulumi.Output<string>;
/**
* Determines whether the suppression for this alert rule is enabled or disabled.
*/
readonly suppressionEnabled: pulumi.Output<boolean>;
/**
* Azure Resource Manager metadata containing createdBy and modifiedBy information.
*/
readonly systemData: pulumi.Output<outputs.securityinsights.SystemDataResponse>;
/**
* The tactics of the alert rule
*/
readonly tactics: pulumi.Output<string[] | undefined>;
/**
* The techniques of the alert rule
*/
readonly techniques: pulumi.Output<string[] | undefined>;
/**
* The version of the alert rule template used to create this rule - in format <a.b.c>, where all are numbers, for example 0 <1.0.2>
*/
readonly templateVersion: pulumi.Output<string | undefined>;
/**
* The operation against the threshold that triggers alert rule.
*/
readonly triggerOperator: pulumi.Output<string>;
/**
* The threshold triggers this alert rule.
*/
readonly triggerThreshold: pulumi.Output<number>;
/**
* The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
*/
readonly type: pulumi.Output<string>;
/**
* Create a ScheduledAlertRule resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: ScheduledAlertRuleArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a ScheduledAlertRule resource.
*/
export interface ScheduledAlertRuleArgs {
/**
* The alert details override settings
*/
alertDetailsOverride?: pulumi.Input<inputs.securityinsights.AlertDetailsOverrideArgs>;
/**
* The Name of the alert rule template used to create this rule.
*/
alertRuleTemplateName?: pulumi.Input<string>;
/**
* Dictionary of string key-value pairs of columns to be attached to the alert
*/
customDetails?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* The description of the alert rule.
*/
description?: pulumi.Input<string>;
/**
* The display name for alerts created by this alert rule.
*/
displayName: pulumi.Input<string>;
/**
* Determines whether this alert rule is enabled or disabled.
*/
enabled: pulumi.Input<boolean>;
/**
* Array of the entity mappings of the alert rule
*/
entityMappings?: pulumi.Input<pulumi.Input<inputs.securityinsights.EntityMappingArgs>[]>;
/**
* The event grouping settings.
*/
eventGroupingSettings?: pulumi.Input<inputs.securityinsights.EventGroupingSettingsArgs>;
/**
* The settings of the incidents that created from alerts triggered by this analytics rule
*/
incidentConfiguration?: pulumi.Input<inputs.securityinsights.IncidentConfigurationArgs>;
/**
* The kind of the alert rule
* Expected value is 'Scheduled'.
*/
kind: pulumi.Input<"Scheduled">;
/**
* The query that creates alerts for this rule.
*/
query: pulumi.Input<string>;
/**
* The frequency (in ISO 8601 duration format) for this alert rule to run.
*/
queryFrequency: pulumi.Input<string>;
/**
* The period (in ISO 8601 duration format) that this alert rule looks at.
*/
queryPeriod: pulumi.Input<string>;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: pulumi.Input<string>;
/**
* Alert rule ID
*/
ruleId?: pulumi.Input<string>;
/**
* The severity for alerts created by this alert rule.
*/
severity: pulumi.Input<string | enums.securityinsights.AlertSeverity>;
/**
* The suppression (in ISO 8601 duration format) to wait since last time this alert rule been triggered.
*/
suppressionDuration: pulumi.Input<string>;
/**
* Determines whether the suppression for this alert rule is enabled or disabled.
*/
suppressionEnabled: pulumi.Input<boolean>;
/**
* The tactics of the alert rule
*/
tactics?: pulumi.Input<pulumi.Input<string | enums.securityinsights.AttackTactic>[]>;
/**
* The techniques of the alert rule
*/
techniques?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The version of the alert rule template used to create this rule - in format <a.b.c>, where all are numbers, for example 0 <1.0.2>
*/
templateVersion?: pulumi.Input<string>;
/**
* The operation against the threshold that triggers alert rule.
*/
triggerOperator: pulumi.Input<enums.securityinsights.TriggerOperator>;
/**
* The threshold triggers this alert rule.
*/
triggerThreshold: pulumi.Input<number>;
/**
* The name of the workspace.
*/
workspaceName: pulumi.Input<string>;
}