@pulumi/azure-native/monitor/getMetricAlert.d.ts

[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [![Python version](https://badge.fury.io/py/pu

import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
 * Retrieve an alert rule definition.
 *
 * Uses Azure REST API version 2018-03-01.
 */
export declare function getMetricAlert(args: GetMetricAlertArgs, opts?: pulumi.InvokeOptions): Promise<GetMetricAlertResult>;
export interface GetMetricAlertArgs {
    /**
     * The name of the resource group. The name is case insensitive.
     */
    resourceGroupName: string;
    /**
     * The name of the rule.
     */
    ruleName: string;
}
/**
 * The metric alert resource.
 */
export interface GetMetricAlertResult {
    /**
     * the array of actions that are performed when the alert rule becomes active, and when an alert condition is resolved.
     */
    readonly actions?: outputs.monitor.MetricAlertActionResponse[];
    /**
     * the flag that indicates whether the alert should be auto resolved or not. The default is true.
     */
    readonly autoMitigate?: boolean;
    /**
     * The Azure API version of the resource.
     */
    readonly azureApiVersion: string;
    /**
     * defines the specific alert criteria information.
     */
    readonly criteria: outputs.monitor.MetricAlertMultipleResourceMultipleMetricCriteriaResponse | outputs.monitor.MetricAlertSingleResourceMultipleMetricCriteriaResponse | outputs.monitor.WebtestLocationAvailabilityCriteriaResponse;
    /**
     * the description of the metric alert that will be included in the alert email.
     */
    readonly description?: string;
    /**
     * the flag that indicates whether the metric alert is enabled.
     */
    readonly enabled: boolean;
    /**
     * how often the metric alert is evaluated represented in ISO 8601 duration format.
     */
    readonly evaluationFrequency: string;
    /**
     * Azure resource Id
     */
    readonly id: string;
    /**
     * the value indicating whether this alert rule is migrated.
     */
    readonly isMigrated: boolean;
    /**
     * Last time the rule was updated in ISO8601 format.
     */
    readonly lastUpdatedTime: string;
    /**
     * Resource location
     */
    readonly location: string;
    /**
     * Azure resource name
     */
    readonly name: string;
    /**
     * the list of resource id's that this metric alert is scoped to. You cannot change the scope of a metric rule based on logs.
     */
    readonly scopes: string[];
    /**
     * Alert severity {0, 1, 2, 3, 4}
     */
    readonly severity: number;
    /**
     * Resource tags
     */
    readonly tags?: {
        [key: string]: 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.
     */
    readonly targetResourceRegion?: 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.
     */
    readonly targetResourceType?: string;
    /**
     * Azure resource type
     */
    readonly type: string;
    /**
     * the period of time (in ISO 8601 duration format) that is used to monitor alert activity based on the threshold.
     */
    readonly windowSize: string;
}
/**
 * Retrieve an alert rule definition.
 *
 * Uses Azure REST API version 2018-03-01.
 */
export declare function getMetricAlertOutput(args: GetMetricAlertOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetMetricAlertResult>;
export interface GetMetricAlertOutputArgs {
    /**
     * The name of the resource group. The name is case insensitive.
     */
    resourceGroupName: pulumi.Input<string>;
    /**
     * The name of the rule.
     */
    ruleName: pulumi.Input<string>;
}