Documentation
¶
Index ¶
- type AlertRule
- func (r *AlertRule) Aggregation() *pulumi.StringOutput
- func (r *AlertRule) Description() *pulumi.StringOutput
- func (r *AlertRule) EmailAction() *pulumi.Output
- func (r *AlertRule) Enabled() *pulumi.BoolOutput
- func (r *AlertRule) ID() *pulumi.IDOutput
- func (r *AlertRule) Location() *pulumi.StringOutput
- func (r *AlertRule) MetricName() *pulumi.StringOutput
- func (r *AlertRule) Name() *pulumi.StringOutput
- func (r *AlertRule) Operator() *pulumi.StringOutput
- func (r *AlertRule) Period() *pulumi.StringOutput
- func (r *AlertRule) ResourceGroupName() *pulumi.StringOutput
- func (r *AlertRule) ResourceId() *pulumi.StringOutput
- func (r *AlertRule) Tags() *pulumi.MapOutput
- func (r *AlertRule) Threshold() *pulumi.Float64Output
- func (r *AlertRule) URN() *pulumi.URNOutput
- func (r *AlertRule) WebhookAction() *pulumi.Output
- type AlertRuleArgs
- type AlertRuleState
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AlertRule ¶
type AlertRule struct {
// contains filtered or unexported fields
}
Manages a [metric-based alert rule](https://docs.microsoft.com/en-us/azure/monitoring-and-diagnostics/monitor-quick-resource-metric-alert-portal) in Azure Monitor.
func GetAlertRule ¶
func GetAlertRule(ctx *pulumi.Context, name string, id pulumi.ID, state *AlertRuleState, opts ...pulumi.ResourceOpt) (*AlertRule, error)
GetAlertRule gets an existing AlertRule resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewAlertRule ¶
func NewAlertRule(ctx *pulumi.Context, name string, args *AlertRuleArgs, opts ...pulumi.ResourceOpt) (*AlertRule, error)
NewAlertRule registers a new resource with the given unique name, arguments, and options.
func (*AlertRule) Aggregation ¶
func (r *AlertRule) Aggregation() *pulumi.StringOutput
Defines how the metric data is combined over time. Possible values are `Average`, `Minimum`, `Maximum`, `Total`, and `Last`.
func (*AlertRule) Description ¶
func (r *AlertRule) Description() *pulumi.StringOutput
A verbose description of the alert rule that will be included in the alert email.
func (*AlertRule) EmailAction ¶
A `email_action` block as defined below.
func (*AlertRule) Enabled ¶
func (r *AlertRule) Enabled() *pulumi.BoolOutput
If `true`, the alert rule is enabled. Defaults to `true`.
func (*AlertRule) Location ¶
func (r *AlertRule) Location() *pulumi.StringOutput
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
func (*AlertRule) MetricName ¶
func (r *AlertRule) MetricName() *pulumi.StringOutput
The metric that defines what the rule monitors.
func (*AlertRule) Name ¶
func (r *AlertRule) Name() *pulumi.StringOutput
Specifies the name of the alert rule. Changing this forces a new resource to be created.
func (*AlertRule) Operator ¶
func (r *AlertRule) Operator() *pulumi.StringOutput
The operator used to compare the metric data and the threshold. Possible values are `GreaterThan`, `GreaterThanOrEqual`, `LessThan`, and `LessThanOrEqual`.
func (*AlertRule) Period ¶
func (r *AlertRule) Period() *pulumi.StringOutput
The period of time formatted in [ISO 8601 duration format](https://en.wikipedia.org/wiki/ISO_8601#Durations) that is used to monitor the alert activity based on the threshold. The period must be between 5 minutes and 1 day.
func (*AlertRule) ResourceGroupName ¶
func (r *AlertRule) ResourceGroupName() *pulumi.StringOutput
The name of the resource group in which to create the alert rule. Changing this forces a new resource to be created.
func (*AlertRule) ResourceId ¶
func (r *AlertRule) ResourceId() *pulumi.StringOutput
The ID of the resource monitored by the alert rule.
func (*AlertRule) Tags ¶
A mapping of tags to assign to the resource. Changing this forces a new resource to be created.
func (*AlertRule) Threshold ¶
func (r *AlertRule) Threshold() *pulumi.Float64Output
The threshold value that activates the alert.
func (*AlertRule) WebhookAction ¶
A `webhook_action` block as defined below.
type AlertRuleArgs ¶
type AlertRuleArgs struct { // Defines how the metric data is combined over time. Possible values are `Average`, `Minimum`, `Maximum`, `Total`, and `Last`. Aggregation interface{} // A verbose description of the alert rule that will be included in the alert email. Description interface{} // A `email_action` block as defined below. EmailAction interface{} // If `true`, the alert rule is enabled. Defaults to `true`. Enabled interface{} // Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created. Location interface{} // The metric that defines what the rule monitors. MetricName interface{} // Specifies the name of the alert rule. Changing this forces a new resource to be created. Name interface{} // The operator used to compare the metric data and the threshold. Possible values are `GreaterThan`, `GreaterThanOrEqual`, `LessThan`, and `LessThanOrEqual`. Operator interface{} // The period of time formatted in [ISO 8601 duration format](https://en.wikipedia.org/wiki/ISO_8601#Durations) that is used to monitor the alert activity based on the threshold. The period must be between 5 minutes and 1 day. Period interface{} // The name of the resource group in which to create the alert rule. Changing this forces a new resource to be created. ResourceGroupName interface{} // The ID of the resource monitored by the alert rule. ResourceId interface{} // A mapping of tags to assign to the resource. Changing this forces a new resource to be created. Tags interface{} // The threshold value that activates the alert. Threshold interface{} // A `webhook_action` block as defined below. WebhookAction interface{} }
The set of arguments for constructing a AlertRule resource.
type AlertRuleState ¶
type AlertRuleState struct { // Defines how the metric data is combined over time. Possible values are `Average`, `Minimum`, `Maximum`, `Total`, and `Last`. Aggregation interface{} // A verbose description of the alert rule that will be included in the alert email. Description interface{} // A `email_action` block as defined below. EmailAction interface{} // If `true`, the alert rule is enabled. Defaults to `true`. Enabled interface{} // Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created. Location interface{} // The metric that defines what the rule monitors. MetricName interface{} // Specifies the name of the alert rule. Changing this forces a new resource to be created. Name interface{} // The operator used to compare the metric data and the threshold. Possible values are `GreaterThan`, `GreaterThanOrEqual`, `LessThan`, and `LessThanOrEqual`. Operator interface{} // The period of time formatted in [ISO 8601 duration format](https://en.wikipedia.org/wiki/ISO_8601#Durations) that is used to monitor the alert activity based on the threshold. The period must be between 5 minutes and 1 day. Period interface{} // The name of the resource group in which to create the alert rule. Changing this forces a new resource to be created. ResourceGroupName interface{} // The ID of the resource monitored by the alert rule. ResourceId interface{} // A mapping of tags to assign to the resource. Changing this forces a new resource to be created. Tags interface{} // The threshold value that activates the alert. Threshold interface{} // A `webhook_action` block as defined below. WebhookAction interface{} }
Input properties used for looking up and filtering AlertRule resources.