All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.pulumi.azure.monitoring.kotlin.MetricAlert.kt Maven / Gradle / Ivy

@file:Suppress("NAME_SHADOWING", "DEPRECATION")

package com.pulumi.azure.monitoring.kotlin

import com.pulumi.azure.monitoring.kotlin.outputs.MetricAlertAction
import com.pulumi.azure.monitoring.kotlin.outputs.MetricAlertApplicationInsightsWebTestLocationAvailabilityCriteria
import com.pulumi.azure.monitoring.kotlin.outputs.MetricAlertCriteria
import com.pulumi.azure.monitoring.kotlin.outputs.MetricAlertDynamicCriteria
import com.pulumi.core.Output
import com.pulumi.kotlin.KotlinCustomResource
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.ResourceMapper
import com.pulumi.kotlin.options.CustomResourceOptions
import com.pulumi.kotlin.options.CustomResourceOptionsBuilder
import com.pulumi.resources.Resource
import kotlin.Boolean
import kotlin.Int
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.List
import kotlin.collections.Map
import com.pulumi.azure.monitoring.kotlin.outputs.MetricAlertAction.Companion.toKotlin as metricAlertActionToKotlin
import com.pulumi.azure.monitoring.kotlin.outputs.MetricAlertApplicationInsightsWebTestLocationAvailabilityCriteria.Companion.toKotlin as metricAlertApplicationInsightsWebTestLocationAvailabilityCriteriaToKotlin
import com.pulumi.azure.monitoring.kotlin.outputs.MetricAlertCriteria.Companion.toKotlin as metricAlertCriteriaToKotlin
import com.pulumi.azure.monitoring.kotlin.outputs.MetricAlertDynamicCriteria.Companion.toKotlin as metricAlertDynamicCriteriaToKotlin

/**
 * Builder for [MetricAlert].
 */
@PulumiTagMarker
public class MetricAlertResourceBuilder internal constructor() {
    public var name: String? = null

    public var args: MetricAlertArgs = MetricAlertArgs()

    public var opts: CustomResourceOptions = CustomResourceOptions()

    /**
     * @param name The _unique_ name of the resulting resource.
     */
    public fun name(`value`: String) {
        this.name = value
    }

    /**
     * @param block The arguments to use to populate this resource's properties.
     */
    public suspend fun args(block: suspend MetricAlertArgsBuilder.() -> Unit) {
        val builder = MetricAlertArgsBuilder()
        block(builder)
        this.args = builder.build()
    }

    /**
     * @param block A bag of options that control this resource's behavior.
     */
    public suspend fun opts(block: suspend CustomResourceOptionsBuilder.() -> Unit) {
        this.opts = com.pulumi.kotlin.options.CustomResourceOptions.opts(block)
    }

    internal fun build(): MetricAlert {
        val builtJavaResource = com.pulumi.azure.monitoring.MetricAlert(
            this.name,
            this.args.toJava(),
            this.opts.toJava(),
        )
        return MetricAlert(builtJavaResource)
    }
}

/**
 * Manages a Metric Alert within Azure Monitor.
 * ## Example Usage
 * 
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as azure from "@pulumi/azure";
 * const example = new azure.core.ResourceGroup("example", {
 *     name: "example-resources",
 *     location: "West Europe",
 * });
 * const toMonitor = new azure.storage.Account("to_monitor", {
 *     name: "examplestorageaccount",
 *     resourceGroupName: example.name,
 *     location: example.location,
 *     accountTier: "Standard",
 *     accountReplicationType: "LRS",
 * });
 * const main = new azure.monitoring.ActionGroup("main", {
 *     name: "example-actiongroup",
 *     resourceGroupName: example.name,
 *     shortName: "exampleact",
 *     webhookReceivers: [{
 *         name: "callmyapi",
 *         serviceUri: "http://example.com/alert",
 *     }],
 * });
 * const exampleMetricAlert = new azure.monitoring.MetricAlert("example", {
 *     name: "example-metricalert",
 *     resourceGroupName: example.name,
 *     scopes: [toMonitor.id],
 *     description: "Action will be triggered when Transactions count is greater than 50.",
 *     criterias: [{
 *         metricNamespace: "Microsoft.Storage/storageAccounts",
 *         metricName: "Transactions",
 *         aggregation: "Total",
 *         operator: "GreaterThan",
 *         threshold: 50,
 *         dimensions: [{
 *             name: "ApiName",
 *             operator: "Include",
 *             values: ["*"],
 *         }],
 *     }],
 *     actions: [{
 *         actionGroupId: main.id,
 *     }],
 * });
 * ```
 * ```python
 * import pulumi
 * import pulumi_azure as azure
 * example = azure.core.ResourceGroup("example",
 *     name="example-resources",
 *     location="West Europe")
 * to_monitor = azure.storage.Account("to_monitor",
 *     name="examplestorageaccount",
 *     resource_group_name=example.name,
 *     location=example.location,
 *     account_tier="Standard",
 *     account_replication_type="LRS")
 * main = azure.monitoring.ActionGroup("main",
 *     name="example-actiongroup",
 *     resource_group_name=example.name,
 *     short_name="exampleact",
 *     webhook_receivers=[{
 *         "name": "callmyapi",
 *         "service_uri": "http://example.com/alert",
 *     }])
 * example_metric_alert = azure.monitoring.MetricAlert("example",
 *     name="example-metricalert",
 *     resource_group_name=example.name,
 *     scopes=[to_monitor.id],
 *     description="Action will be triggered when Transactions count is greater than 50.",
 *     criterias=[{
 *         "metric_namespace": "Microsoft.Storage/storageAccounts",
 *         "metric_name": "Transactions",
 *         "aggregation": "Total",
 *         "operator": "GreaterThan",
 *         "threshold": 50,
 *         "dimensions": [{
 *             "name": "ApiName",
 *             "operator": "Include",
 *             "values": ["*"],
 *         }],
 *     }],
 *     actions=[{
 *         "action_group_id": main.id,
 *     }])
 * ```
 * ```csharp
 * using System.Collections.Generic;
 * using System.Linq;
 * using Pulumi;
 * using Azure = Pulumi.Azure;
 * return await Deployment.RunAsync(() =>
 * {
 *     var example = new Azure.Core.ResourceGroup("example", new()
 *     {
 *         Name = "example-resources",
 *         Location = "West Europe",
 *     });
 *     var toMonitor = new Azure.Storage.Account("to_monitor", new()
 *     {
 *         Name = "examplestorageaccount",
 *         ResourceGroupName = example.Name,
 *         Location = example.Location,
 *         AccountTier = "Standard",
 *         AccountReplicationType = "LRS",
 *     });
 *     var main = new Azure.Monitoring.ActionGroup("main", new()
 *     {
 *         Name = "example-actiongroup",
 *         ResourceGroupName = example.Name,
 *         ShortName = "exampleact",
 *         WebhookReceivers = new[]
 *         {
 *             new Azure.Monitoring.Inputs.ActionGroupWebhookReceiverArgs
 *             {
 *                 Name = "callmyapi",
 *                 ServiceUri = "http://example.com/alert",
 *             },
 *         },
 *     });
 *     var exampleMetricAlert = new Azure.Monitoring.MetricAlert("example", new()
 *     {
 *         Name = "example-metricalert",
 *         ResourceGroupName = example.Name,
 *         Scopes = new[]
 *         {
 *             toMonitor.Id,
 *         },
 *         Description = "Action will be triggered when Transactions count is greater than 50.",
 *         Criterias = new[]
 *         {
 *             new Azure.Monitoring.Inputs.MetricAlertCriteriaArgs
 *             {
 *                 MetricNamespace = "Microsoft.Storage/storageAccounts",
 *                 MetricName = "Transactions",
 *                 Aggregation = "Total",
 *                 Operator = "GreaterThan",
 *                 Threshold = 50,
 *                 Dimensions = new[]
 *                 {
 *                     new Azure.Monitoring.Inputs.MetricAlertCriteriaDimensionArgs
 *                     {
 *                         Name = "ApiName",
 *                         Operator = "Include",
 *                         Values = new[]
 *                         {
 *                             "*",
 *                         },
 *                     },
 *                 },
 *             },
 *         },
 *         Actions = new[]
 *         {
 *             new Azure.Monitoring.Inputs.MetricAlertActionArgs
 *             {
 *                 ActionGroupId = main.Id,
 *             },
 *         },
 *     });
 * });
 * ```
 * ```go
 * package main
 * import (
 * 	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
 * 	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/monitoring"
 * 	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/storage"
 * 	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
 * )
 * func main() {
 * 	pulumi.Run(func(ctx *pulumi.Context) error {
 * 		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
 * 			Name:     pulumi.String("example-resources"),
 * 			Location: pulumi.String("West Europe"),
 * 		})
 * 		if err != nil {
 * 			return err
 * 		}
 * 		toMonitor, err := storage.NewAccount(ctx, "to_monitor", &storage.AccountArgs{
 * 			Name:                   pulumi.String("examplestorageaccount"),
 * 			ResourceGroupName:      example.Name,
 * 			Location:               example.Location,
 * 			AccountTier:            pulumi.String("Standard"),
 * 			AccountReplicationType: pulumi.String("LRS"),
 * 		})
 * 		if err != nil {
 * 			return err
 * 		}
 * 		main, err := monitoring.NewActionGroup(ctx, "main", &monitoring.ActionGroupArgs{
 * 			Name:              pulumi.String("example-actiongroup"),
 * 			ResourceGroupName: example.Name,
 * 			ShortName:         pulumi.String("exampleact"),
 * 			WebhookReceivers: monitoring.ActionGroupWebhookReceiverArray{
 * 				&monitoring.ActionGroupWebhookReceiverArgs{
 * 					Name:       pulumi.String("callmyapi"),
 * 					ServiceUri: pulumi.String("http://example.com/alert"),
 * 				},
 * 			},
 * 		})
 * 		if err != nil {
 * 			return err
 * 		}
 * 		_, err = monitoring.NewMetricAlert(ctx, "example", &monitoring.MetricAlertArgs{
 * 			Name:              pulumi.String("example-metricalert"),
 * 			ResourceGroupName: example.Name,
 * 			Scopes: pulumi.StringArray{
 * 				toMonitor.ID(),
 * 			},
 * 			Description: pulumi.String("Action will be triggered when Transactions count is greater than 50."),
 * 			Criterias: monitoring.MetricAlertCriteriaArray{
 * 				&monitoring.MetricAlertCriteriaArgs{
 * 					MetricNamespace: pulumi.String("Microsoft.Storage/storageAccounts"),
 * 					MetricName:      pulumi.String("Transactions"),
 * 					Aggregation:     pulumi.String("Total"),
 * 					Operator:        pulumi.String("GreaterThan"),
 * 					Threshold:       pulumi.Float64(50),
 * 					Dimensions: monitoring.MetricAlertCriteriaDimensionArray{
 * 						&monitoring.MetricAlertCriteriaDimensionArgs{
 * 							Name:     pulumi.String("ApiName"),
 * 							Operator: pulumi.String("Include"),
 * 							Values: pulumi.StringArray{
 * 								pulumi.String("*"),
 * 							},
 * 						},
 * 					},
 * 				},
 * 			},
 * 			Actions: monitoring.MetricAlertActionArray{
 * 				&monitoring.MetricAlertActionArgs{
 * 					ActionGroupId: main.ID(),
 * 				},
 * 			},
 * 		})
 * 		if err != nil {
 * 			return err
 * 		}
 * 		return nil
 * 	})
 * }
 * ```
 * ```java
 * package generated_program;
 * import com.pulumi.Context;
 * import com.pulumi.Pulumi;
 * import com.pulumi.core.Output;
 * import com.pulumi.azure.core.ResourceGroup;
 * import com.pulumi.azure.core.ResourceGroupArgs;
 * import com.pulumi.azure.storage.Account;
 * import com.pulumi.azure.storage.AccountArgs;
 * import com.pulumi.azure.monitoring.ActionGroup;
 * import com.pulumi.azure.monitoring.ActionGroupArgs;
 * import com.pulumi.azure.monitoring.inputs.ActionGroupWebhookReceiverArgs;
 * import com.pulumi.azure.monitoring.MetricAlert;
 * import com.pulumi.azure.monitoring.MetricAlertArgs;
 * import com.pulumi.azure.monitoring.inputs.MetricAlertCriteriaArgs;
 * import com.pulumi.azure.monitoring.inputs.MetricAlertActionArgs;
 * import java.util.List;
 * import java.util.ArrayList;
 * import java.util.Map;
 * import java.io.File;
 * import java.nio.file.Files;
 * import java.nio.file.Paths;
 * public class App {
 *     public static void main(String[] args) {
 *         Pulumi.run(App::stack);
 *     }
 *     public static void stack(Context ctx) {
 *         var example = new ResourceGroup("example", ResourceGroupArgs.builder()
 *             .name("example-resources")
 *             .location("West Europe")
 *             .build());
 *         var toMonitor = new Account("toMonitor", AccountArgs.builder()
 *             .name("examplestorageaccount")
 *             .resourceGroupName(example.name())
 *             .location(example.location())
 *             .accountTier("Standard")
 *             .accountReplicationType("LRS")
 *             .build());
 *         var main = new ActionGroup("main", ActionGroupArgs.builder()
 *             .name("example-actiongroup")
 *             .resourceGroupName(example.name())
 *             .shortName("exampleact")
 *             .webhookReceivers(ActionGroupWebhookReceiverArgs.builder()
 *                 .name("callmyapi")
 *                 .serviceUri("http://example.com/alert")
 *                 .build())
 *             .build());
 *         var exampleMetricAlert = new MetricAlert("exampleMetricAlert", MetricAlertArgs.builder()
 *             .name("example-metricalert")
 *             .resourceGroupName(example.name())
 *             .scopes(toMonitor.id())
 *             .description("Action will be triggered when Transactions count is greater than 50.")
 *             .criterias(MetricAlertCriteriaArgs.builder()
 *                 .metricNamespace("Microsoft.Storage/storageAccounts")
 *                 .metricName("Transactions")
 *                 .aggregation("Total")
 *                 .operator("GreaterThan")
 *                 .threshold(50)
 *                 .dimensions(MetricAlertCriteriaDimensionArgs.builder()
 *                     .name("ApiName")
 *                     .operator("Include")
 *                     .values("*")
 *                     .build())
 *                 .build())
 *             .actions(MetricAlertActionArgs.builder()
 *                 .actionGroupId(main.id())
 *                 .build())
 *             .build());
 *     }
 * }
 * ```
 * ```yaml
 * resources:
 *   example:
 *     type: azure:core:ResourceGroup
 *     properties:
 *       name: example-resources
 *       location: West Europe
 *   toMonitor:
 *     type: azure:storage:Account
 *     name: to_monitor
 *     properties:
 *       name: examplestorageaccount
 *       resourceGroupName: ${example.name}
 *       location: ${example.location}
 *       accountTier: Standard
 *       accountReplicationType: LRS
 *   main:
 *     type: azure:monitoring:ActionGroup
 *     properties:
 *       name: example-actiongroup
 *       resourceGroupName: ${example.name}
 *       shortName: exampleact
 *       webhookReceivers:
 *         - name: callmyapi
 *           serviceUri: http://example.com/alert
 *   exampleMetricAlert:
 *     type: azure:monitoring:MetricAlert
 *     name: example
 *     properties:
 *       name: example-metricalert
 *       resourceGroupName: ${example.name}
 *       scopes:
 *         - ${toMonitor.id}
 *       description: Action will be triggered when Transactions count is greater than 50.
 *       criterias:
 *         - metricNamespace: Microsoft.Storage/storageAccounts
 *           metricName: Transactions
 *           aggregation: Total
 *           operator: GreaterThan
 *           threshold: 50
 *           dimensions:
 *             - name: ApiName
 *               operator: Include
 *               values:
 *                 - '*'
 *       actions:
 *         - actionGroupId: ${main.id}
 * ```
 * 
 * ## Import
 * Metric Alerts can be imported using the `resource id`, e.g.
 * ```sh
 * $ pulumi import azure:monitoring/metricAlert:MetricAlert main /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/example-resources/providers/Microsoft.Insights/metricAlerts/example-metricalert
 * ```
 */
public class MetricAlert internal constructor(
    override val javaResource: com.pulumi.azure.monitoring.MetricAlert,
) : KotlinCustomResource(javaResource, MetricAlertMapper) {
    /**
     * One or more `action` blocks as defined below.
     */
    public val actions: Output>?
        get() = javaResource.actions().applyValue({ args0 ->
            args0.map({ args0 ->
                args0.map({ args0 ->
                    args0.let({ args0 -> metricAlertActionToKotlin(args0) })
                })
            }).orElse(null)
        })

    /**
     * A `application_insights_web_test_location_availability_criteria` block as defined below.
     * > **NOTE** One of either `criteria`, `dynamic_criteria` or `application_insights_web_test_location_availability_criteria` must be specified.
     */
    public val applicationInsightsWebTestLocationAvailabilityCriteria:
        Output?
        get() =
            javaResource.applicationInsightsWebTestLocationAvailabilityCriteria().applyValue({ args0 ->
                args0.map({ args0 ->
                    args0.let({ args0 ->
                        metricAlertApplicationInsightsWebTestLocationAvailabilityCriteriaToKotlin(args0)
                    })
                }).orElse(null)
            })

    /**
     * Should the alerts in this Metric Alert be auto resolved? Defaults to `true`.
     */
    public val autoMitigate: Output?
        get() = javaResource.autoMitigate().applyValue({ args0 ->
            args0.map({ args0 ->
                args0
            }).orElse(null)
        })

    /**
     * One or more (static) `criteria` blocks as defined below.
     * > **NOTE** One of either `criteria`, `dynamic_criteria` or `application_insights_web_test_location_availability_criteria` must be specified.
     */
    public val criterias: Output>?
        get() = javaResource.criterias().applyValue({ args0 ->
            args0.map({ args0 ->
                args0.map({ args0 ->
                    args0.let({ args0 -> metricAlertCriteriaToKotlin(args0) })
                })
            }).orElse(null)
        })

    /**
     * The description of this Metric Alert.
     */
    public val description: Output?
        get() = javaResource.description().applyValue({ args0 ->
            args0.map({ args0 ->
                args0
            }).orElse(null)
        })

    /**
     * A `dynamic_criteria` block as defined below.
     * > **NOTE** One of either `criteria`, `dynamic_criteria` or `application_insights_web_test_location_availability_criteria` must be specified.
     */
    public val dynamicCriteria: Output?
        get() = javaResource.dynamicCriteria().applyValue({ args0 ->
            args0.map({ args0 ->
                args0.let({ args0 -> metricAlertDynamicCriteriaToKotlin(args0) })
            }).orElse(null)
        })

    /**
     * Should this Metric Alert be enabled? Defaults to `true`.
     */
    public val enabled: Output?
        get() = javaResource.enabled().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })

    /**
     * The evaluation frequency of this Metric Alert, represented in ISO 8601 duration format. Possible values are `PT1M`, `PT5M`, `PT15M`, `PT30M` and `PT1H`. Defaults to `PT1M`.
     */
    public val frequency: Output?
        get() = javaResource.frequency().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })

    /**
     * The name of the Metric Alert. Changing this forces a new resource to be created.
     */
    public val name: Output
        get() = javaResource.name().applyValue({ args0 -> args0 })

    /**
     * The name of the resource group in which to create the Metric Alert instance. Changing this forces a new resource to be created.
     */
    public val resourceGroupName: Output
        get() = javaResource.resourceGroupName().applyValue({ args0 -> args0 })

    /**
     * A set of strings of resource IDs at which the metric criteria should be applied.
     */
    public val scopes: Output>
        get() = javaResource.scopes().applyValue({ args0 -> args0.map({ args0 -> args0 }) })

    /**
     * The severity of this Metric Alert. Possible values are `0`, `1`, `2`, `3` and `4`. Defaults to `3`.
     */
    public val severity: Output?
        get() = javaResource.severity().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })

    /**
     * A mapping of tags to assign to the resource.
     */
    public val tags: Output>?
        get() = javaResource.tags().applyValue({ args0 ->
            args0.map({ args0 ->
                args0.map({ args0 ->
                    args0.key.to(args0.value)
                }).toMap()
            }).orElse(null)
        })

    /**
     * The location of the target resource.
     * > This is Required when using a Subscription as scope, a Resource Group as scope or Multiple Scopes.
     */
    public val targetResourceLocation: Output
        get() = javaResource.targetResourceLocation().applyValue({ args0 -> args0 })

    /**
     * The resource type (e.g. `Microsoft.Compute/virtualMachines`) of the target resource.
     * > This is Required when using a Subscription as scope, a Resource Group as scope or Multiple Scopes.
     */
    public val targetResourceType: Output
        get() = javaResource.targetResourceType().applyValue({ args0 -> args0 })

    /**
     * The period of time that is used to monitor alert activity, represented in ISO 8601 duration format. This value must be greater than `frequency`. Possible values are `PT1M`, `PT5M`, `PT15M`, `PT30M`, `PT1H`, `PT6H`, `PT12H` and `P1D`. Defaults to `PT5M`.
     */
    public val windowSize: Output?
        get() = javaResource.windowSize().applyValue({ args0 ->
            args0.map({ args0 ->
                args0
            }).orElse(null)
        })
}

public object MetricAlertMapper : ResourceMapper {
    override fun supportsMappingOfType(javaResource: Resource): Boolean =
        com.pulumi.azure.monitoring.MetricAlert::class == javaResource::class

    override fun map(javaResource: Resource): MetricAlert = MetricAlert(
        javaResource as
            com.pulumi.azure.monitoring.MetricAlert,
    )
}

/**
 * @see [MetricAlert].
 * @param name The _unique_ name of the resulting resource.
 * @param block Builder for [MetricAlert].
 */
public suspend fun metricAlert(name: String, block: suspend MetricAlertResourceBuilder.() -> Unit): MetricAlert {
    val builder = MetricAlertResourceBuilder()
    builder.name(name)
    block(builder)
    return builder.build()
}

/**
 * @see [MetricAlert].
 * @param name The _unique_ name of the resulting resource.
 */
public fun metricAlert(name: String): MetricAlert {
    val builder = MetricAlertResourceBuilder()
    builder.name(name)
    return builder.build()
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy