Azure Native

v1.48.0 published on Monday, Nov 29, 2021 by Pulumi

getMetricAlert

The metric alert resource. API Version: 2018-03-01.

Using getMetricAlert

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getMetricAlert(args: GetMetricAlertArgs, opts?: InvokeOptions): Promise<GetMetricAlertResult>
function getMetricAlertOutput(args: GetMetricAlertOutputArgs, opts?: InvokeOptions): Output<GetMetricAlertResult>
def get_metric_alert(resource_group_name: Optional[str] = None,
                     rule_name: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetMetricAlertResult
def get_metric_alert_output(resource_group_name: Optional[pulumi.Input[str]] = None,
                     rule_name: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetMetricAlertResult]
func LookupMetricAlert(ctx *Context, args *LookupMetricAlertArgs, opts ...InvokeOption) (*LookupMetricAlertResult, error)

> Note: This function is named LookupMetricAlert in the Go SDK.

public static class GetMetricAlert 
{
    public static Task<GetMetricAlertResult> InvokeAsync(GetMetricAlertArgs args, InvokeOptions? opts = null)
    public static Output<GetMetricAlertResult> Invoke(GetMetricAlertInvokeArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

ResourceGroupName string
The name of the resource group.
RuleName string
The name of the rule.
ResourceGroupName string
The name of the resource group.
RuleName string
The name of the rule.
resourceGroupName string
The name of the resource group.
ruleName string
The name of the rule.
resource_group_name str
The name of the resource group.
rule_name str
The name of the rule.

getMetricAlert Result

The following output properties are available:

Criteria Pulumi.AzureNative.Insights.Outputs.MetricAlertMultipleResourceMultipleMetricCriteriaResponse | Pulumi.AzureNative.Insights.Outputs.MetricAlertSingleResourceMultipleMetricCriteriaResponse | Pulumi.AzureNative.Insights.Outputs.WebtestLocationAvailabilityCriteriaResponse
defines the specific alert criteria information.
Enabled bool
the flag that indicates whether the metric alert is enabled.
EvaluationFrequency string
how often the metric alert is evaluated represented in ISO 8601 duration format.
Id string
Azure resource Id
IsMigrated bool
the value indicating whether this alert rule is migrated.
LastUpdatedTime string
Last time the rule was updated in ISO8601 format.
Location string
Resource location
Name string
Azure resource name
Scopes List<string>
the list of resource id’s that this metric alert is scoped to.
Severity int
Alert severity {0, 1, 2, 3, 4}
Type string
Azure resource type
WindowSize string
the period of time (in ISO 8601 duration format) that is used to monitor alert activity based on the threshold.
Actions List<Pulumi.AzureNative.Insights.Outputs.MetricAlertActionResponse>
the array of actions that are performed when the alert rule becomes active, and when an alert condition is resolved.
AutoMitigate bool
the flag that indicates whether the alert should be auto resolved or not. The default is true.
Description string
the description of the metric alert that will be included in the alert email.
Tags Dictionary<string, string>
Resource tags
TargetResourceRegion string
the region of the target resource(s) on which the alert is created/updated. Mandatory if the scope contains a subscription, resource group, or more than one resource.
TargetResourceType string
the resource type of the target resource(s) on which the alert is created/updated. Mandatory if the scope contains a subscription, resource group, or more than one resource.
Criteria MetricAlertMultipleResourceMultipleMetricCriteriaResponse | MetricAlertSingleResourceMultipleMetricCriteriaResponse | WebtestLocationAvailabilityCriteriaResponse
defines the specific alert criteria information.
Enabled bool
the flag that indicates whether the metric alert is enabled.
EvaluationFrequency string
how often the metric alert is evaluated represented in ISO 8601 duration format.
Id string
Azure resource Id
IsMigrated bool
the value indicating whether this alert rule is migrated.
LastUpdatedTime string
Last time the rule was updated in ISO8601 format.
Location string
Resource location
Name string
Azure resource name
Scopes []string
the list of resource id’s that this metric alert is scoped to.
Severity int
Alert severity {0, 1, 2, 3, 4}
Type string
Azure resource type
WindowSize string
the period of time (in ISO 8601 duration format) that is used to monitor alert activity based on the threshold.
Actions []MetricAlertActionResponse
the array of actions that are performed when the alert rule becomes active, and when an alert condition is resolved.
AutoMitigate bool
the flag that indicates whether the alert should be auto resolved or not. The default is true.
Description string
the description of the metric alert that will be included in the alert email.
Tags map[string]string
Resource tags
TargetResourceRegion string
the region of the target resource(s) on which the alert is created/updated. Mandatory if the scope contains a subscription, resource group, or more than one resource.
TargetResourceType string
the resource type of the target resource(s) on which the alert is created/updated. Mandatory if the scope contains a subscription, resource group, or more than one resource.
criteria MetricAlertMultipleResourceMultipleMetricCriteriaResponse | MetricAlertSingleResourceMultipleMetricCriteriaResponse | WebtestLocationAvailabilityCriteriaResponse
defines the specific alert criteria information.
enabled boolean
the flag that indicates whether the metric alert is enabled.
evaluationFrequency string
how often the metric alert is evaluated represented in ISO 8601 duration format.
id string
Azure resource Id
isMigrated boolean
the value indicating whether this alert rule is migrated.
lastUpdatedTime string
Last time the rule was updated in ISO8601 format.
location string
Resource location
name string
Azure resource name
scopes string[]
the list of resource id’s that this metric alert is scoped to.
severity number
Alert severity {0, 1, 2, 3, 4}
type string
Azure resource type
windowSize string
the period of time (in ISO 8601 duration format) that is used to monitor alert activity based on the threshold.
actions MetricAlertActionResponse[]
the array of actions that are performed when the alert rule becomes active, and when an alert condition is resolved.
autoMitigate boolean
the flag that indicates whether the alert should be auto resolved or not. The default is true.
description string
the description of the metric alert that will be included in the alert email.
tags {[key: string]: string}
Resource tags
targetResourceRegion string
the region of the target resource(s) on which the alert is created/updated. Mandatory if the scope contains a subscription, resource group, or more than one resource.
targetResourceType string
the resource type of the target resource(s) on which the alert is created/updated. Mandatory if the scope contains a subscription, resource group, or more than one resource.
criteria MetricAlertMultipleResourceMultipleMetricCriteriaResponse | MetricAlertSingleResourceMultipleMetricCriteriaResponse | WebtestLocationAvailabilityCriteriaResponse
defines the specific alert criteria information.
enabled bool
the flag that indicates whether the metric alert is enabled.
evaluation_frequency str
how often the metric alert is evaluated represented in ISO 8601 duration format.
id str
Azure resource Id
is_migrated bool
the value indicating whether this alert rule is migrated.
last_updated_time str
Last time the rule was updated in ISO8601 format.
location str
Resource location
name str
Azure resource name
scopes Sequence[str]
the list of resource id’s that this metric alert is scoped to.
severity int
Alert severity {0, 1, 2, 3, 4}
type str
Azure resource type
window_size str
the period of time (in ISO 8601 duration format) that is used to monitor alert activity based on the threshold.
actions Sequence[MetricAlertActionResponse]
the array of actions that are performed when the alert rule becomes active, and when an alert condition is resolved.
auto_mitigate bool
the flag that indicates whether the alert should be auto resolved or not. The default is true.
description str
the description of the metric alert that will be included in the alert email.
tags Mapping[str, str]
Resource tags
target_resource_region str
the region of the target resource(s) on which the alert is created/updated. Mandatory if the scope contains a subscription, resource group, or more than one resource.
target_resource_type str
the resource type of the target resource(s) on which the alert is created/updated. Mandatory if the scope contains a subscription, resource group, or more than one resource.

Supporting Types

DynamicMetricCriteriaResponse

AlertSensitivity string
The extent of deviation required to trigger an alert. This will affect how tight the threshold is to the metric series pattern.
FailingPeriods Pulumi.AzureNative.Insights.Inputs.DynamicThresholdFailingPeriodsResponse
The minimum number of violations required within the selected lookback time window required to raise an alert.
MetricName string
Name of the metric.
Name string
Name of the criteria.
Operator string
The operator used to compare the metric value against the threshold.
TimeAggregation string
the criteria time aggregation types.
Dimensions List<Pulumi.AzureNative.Insights.Inputs.MetricDimensionResponse>
List of dimension conditions.
IgnoreDataBefore string
Use this option to set the date from which to start learning the metric historical data and calculate the dynamic thresholds (in ISO8601 format)
MetricNamespace string
Namespace of the metric.
SkipMetricValidation bool
Allows creating an alert rule on a custom metric that isn’t yet emitted, by causing the metric validation to be skipped.
AlertSensitivity string
The extent of deviation required to trigger an alert. This will affect how tight the threshold is to the metric series pattern.
FailingPeriods DynamicThresholdFailingPeriodsResponse
The minimum number of violations required within the selected lookback time window required to raise an alert.
MetricName string
Name of the metric.
Name string
Name of the criteria.
Operator string
The operator used to compare the metric value against the threshold.
TimeAggregation string
the criteria time aggregation types.
Dimensions []MetricDimensionResponse
List of dimension conditions.
IgnoreDataBefore string
Use this option to set the date from which to start learning the metric historical data and calculate the dynamic thresholds (in ISO8601 format)
MetricNamespace string
Namespace of the metric.
SkipMetricValidation bool
Allows creating an alert rule on a custom metric that isn’t yet emitted, by causing the metric validation to be skipped.
alertSensitivity string
The extent of deviation required to trigger an alert. This will affect how tight the threshold is to the metric series pattern.
failingPeriods DynamicThresholdFailingPeriodsResponse
The minimum number of violations required within the selected lookback time window required to raise an alert.
metricName string
Name of the metric.
name string
Name of the criteria.
operator string
The operator used to compare the metric value against the threshold.
timeAggregation string
the criteria time aggregation types.
dimensions MetricDimensionResponse[]
List of dimension conditions.
ignoreDataBefore string
Use this option to set the date from which to start learning the metric historical data and calculate the dynamic thresholds (in ISO8601 format)
metricNamespace string
Namespace of the metric.
skipMetricValidation boolean
Allows creating an alert rule on a custom metric that isn’t yet emitted, by causing the metric validation to be skipped.
alert_sensitivity str
The extent of deviation required to trigger an alert. This will affect how tight the threshold is to the metric series pattern.
failing_periods DynamicThresholdFailingPeriodsResponse
The minimum number of violations required within the selected lookback time window required to raise an alert.
metric_name str
Name of the metric.
name str
Name of the criteria.
operator str
The operator used to compare the metric value against the threshold.
time_aggregation str
the criteria time aggregation types.
dimensions Sequence[MetricDimensionResponse]
List of dimension conditions.
ignore_data_before str
Use this option to set the date from which to start learning the metric historical data and calculate the dynamic thresholds (in ISO8601 format)
metric_namespace str
Namespace of the metric.
skip_metric_validation bool
Allows creating an alert rule on a custom metric that isn’t yet emitted, by causing the metric validation to be skipped.

DynamicThresholdFailingPeriodsResponse

MinFailingPeriodsToAlert double
The number of violations to trigger an alert. Should be smaller or equal to numberOfEvaluationPeriods.
NumberOfEvaluationPeriods double
The number of aggregated lookback points. The lookback time window is calculated based on the aggregation granularity (windowSize) and the selected number of aggregated points.
MinFailingPeriodsToAlert float64
The number of violations to trigger an alert. Should be smaller or equal to numberOfEvaluationPeriods.
NumberOfEvaluationPeriods float64
The number of aggregated lookback points. The lookback time window is calculated based on the aggregation granularity (windowSize) and the selected number of aggregated points.
minFailingPeriodsToAlert number
The number of violations to trigger an alert. Should be smaller or equal to numberOfEvaluationPeriods.
numberOfEvaluationPeriods number
The number of aggregated lookback points. The lookback time window is calculated based on the aggregation granularity (windowSize) and the selected number of aggregated points.
min_failing_periods_to_alert float
The number of violations to trigger an alert. Should be smaller or equal to numberOfEvaluationPeriods.
number_of_evaluation_periods float
The number of aggregated lookback points. The lookback time window is calculated based on the aggregation granularity (windowSize) and the selected number of aggregated points.

MetricAlertActionResponse

ActionGroupId string
the id of the action group to use.
WebHookProperties Dictionary<string, string>
This field allows specifying custom properties, which would be appended to the alert payload sent as input to the webhook.
ActionGroupId string
the id of the action group to use.
WebHookProperties map[string]string
This field allows specifying custom properties, which would be appended to the alert payload sent as input to the webhook.
actionGroupId string
the id of the action group to use.
webHookProperties {[key: string]: string}
This field allows specifying custom properties, which would be appended to the alert payload sent as input to the webhook.
action_group_id str
the id of the action group to use.
web_hook_properties Mapping[str, str]
This field allows specifying custom properties, which would be appended to the alert payload sent as input to the webhook.

MetricAlertMultipleResourceMultipleMetricCriteriaResponse

AllOf List<Union<Pulumi.AzureNative.Insights.Inputs.DynamicMetricCriteriaResponse, Pulumi.AzureNative.Insights.Inputs.MetricCriteriaResponse>>
the list of multiple metric criteria for this ‘all of’ operation.
AllOf []interface{}
the list of multiple metric criteria for this ‘all of’ operation.
allOf (DynamicMetricCriteriaResponse | MetricCriteriaResponse)[]
the list of multiple metric criteria for this ‘all of’ operation.
all_of Sequence[Union[DynamicMetricCriteriaResponse, MetricCriteriaResponse]]
the list of multiple metric criteria for this ‘all of’ operation.

MetricAlertSingleResourceMultipleMetricCriteriaResponse

AllOf List<Pulumi.AzureNative.Insights.Inputs.MetricCriteriaResponse>
The list of metric criteria for this ‘all of’ operation.
AllOf []MetricCriteriaResponse
The list of metric criteria for this ‘all of’ operation.
allOf MetricCriteriaResponse[]
The list of metric criteria for this ‘all of’ operation.
all_of Sequence[MetricCriteriaResponse]
The list of metric criteria for this ‘all of’ operation.

MetricCriteriaResponse

MetricName string
Name of the metric.
Name string
Name of the criteria.
Operator string
the criteria operator.
Threshold double
the criteria threshold value that activates the alert.
TimeAggregation string
the criteria time aggregation types.
Dimensions List<Pulumi.AzureNative.Insights.Inputs.MetricDimensionResponse>
List of dimension conditions.
MetricNamespace string
Namespace of the metric.
SkipMetricValidation bool
Allows creating an alert rule on a custom metric that isn’t yet emitted, by causing the metric validation to be skipped.
MetricName string
Name of the metric.
Name string
Name of the criteria.
Operator string
the criteria operator.
Threshold float64
the criteria threshold value that activates the alert.
TimeAggregation string
the criteria time aggregation types.
Dimensions []MetricDimensionResponse
List of dimension conditions.
MetricNamespace string
Namespace of the metric.
SkipMetricValidation bool
Allows creating an alert rule on a custom metric that isn’t yet emitted, by causing the metric validation to be skipped.
metricName string
Name of the metric.
name string
Name of the criteria.
operator string
the criteria operator.
threshold number
the criteria threshold value that activates the alert.
timeAggregation string
the criteria time aggregation types.
dimensions MetricDimensionResponse[]
List of dimension conditions.
metricNamespace string
Namespace of the metric.
skipMetricValidation boolean
Allows creating an alert rule on a custom metric that isn’t yet emitted, by causing the metric validation to be skipped.
metric_name str
Name of the metric.
name str
Name of the criteria.
operator str
the criteria operator.
threshold float
the criteria threshold value that activates the alert.
time_aggregation str
the criteria time aggregation types.
dimensions Sequence[MetricDimensionResponse]
List of dimension conditions.
metric_namespace str
Namespace of the metric.
skip_metric_validation bool
Allows creating an alert rule on a custom metric that isn’t yet emitted, by causing the metric validation to be skipped.

MetricDimensionResponse

Name string
Name of the dimension.
Operator string
the dimension operator. Only ‘Include’ and ‘Exclude’ are supported
Values List<string>
list of dimension values.
Name string
Name of the dimension.
Operator string
the dimension operator. Only ‘Include’ and ‘Exclude’ are supported
Values []string
list of dimension values.
name string
Name of the dimension.
operator string
the dimension operator. Only ‘Include’ and ‘Exclude’ are supported
values string[]
list of dimension values.
name str
Name of the dimension.
operator str
the dimension operator. Only ‘Include’ and ‘Exclude’ are supported
values Sequence[str]
list of dimension values.

WebtestLocationAvailabilityCriteriaResponse

ComponentId string
The Application Insights resource Id.
FailedLocationCount double
The number of failed locations.
WebTestId string
The Application Insights web test Id.
ComponentId string
The Application Insights resource Id.
FailedLocationCount float64
The number of failed locations.
WebTestId string
The Application Insights web test Id.
componentId string
The Application Insights resource Id.
failedLocationCount number
The number of failed locations.
webTestId string
The Application Insights web test Id.
component_id str
The Application Insights resource Id.
failed_location_count float
The number of failed locations.
web_test_id str
The Application Insights web test Id.

Package Details

Repository
https://github.com/pulumi/pulumi-azure-native
License
Apache-2.0