Insights

Manages an Application Insights component.

Example Usage

using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new Azure.Core.ResourceGroupArgs
        {
            Location = "West Europe",
        });
        var exampleInsights = new Azure.AppInsights.Insights("exampleInsights", new Azure.AppInsights.InsightsArgs
        {
            Location = exampleResourceGroup.Location,
            ResourceGroupName = exampleResourceGroup.Name,
            ApplicationType = "web",
        });
        this.InstrumentationKey = exampleInsights.InstrumentationKey;
        this.AppId = exampleInsights.AppId;
    }

    [Output("instrumentationKey")]
    public Output<string> InstrumentationKey { get; set; }
    [Output("appId")]
    public Output<string> AppId { get; set; }
}

package main

import (
    "github.com/pulumi/pulumi-azure/sdk/v3/go/azure/appinsights"
    "github.com/pulumi/pulumi-azure/sdk/v3/go/azure/core"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
            Location: pulumi.String("West Europe"),
        })
        if err != nil {
            return err
        }
        exampleInsights, err := appinsights.NewInsights(ctx, "exampleInsights", &appinsights.InsightsArgs{
            Location:          exampleResourceGroup.Location,
            ResourceGroupName: exampleResourceGroup.Name,
            ApplicationType:   pulumi.String("web"),
        })
        if err != nil {
            return err
        }
        ctx.Export("instrumentationKey", exampleInsights.InstrumentationKey)
        ctx.Export("appId", exampleInsights.AppId)
        return nil
    })
}

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_insights = azure.appinsights.Insights("exampleInsights",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    application_type="web")
pulumi.export("instrumentationKey", example_insights.instrumentation_key)
pulumi.export("appId", example_insights.app_id)

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleInsights = new azure.appinsights.Insights("exampleInsights", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    applicationType: "web",
});
export const instrumentationKey = exampleInsights.instrumentationKey;
export const appId = exampleInsights.appId;

Create a Insights Resource

new Insights(name: string, args: InsightsArgs, opts?: CustomResourceOptions);

def Insights(resource_name, opts=None, application_type=None, daily_data_cap_in_gb=None, daily_data_cap_notifications_disabled=None, disable_ip_masking=None, location=None, name=None, resource_group_name=None, retention_in_days=None, sampling_percentage=None, tags=None, __props__=None);

func NewInsights(ctx *Context, name string, args InsightsArgs, opts ...ResourceOption) (*Insights, error)

public Insights(string name, InsightsArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args InsightsArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args InsightsArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args InsightsArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

Insights Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The Insights resource accepts the following input properties:

ApplicationType string: Specifies the type of Application Insights to create. Valid values are ios for iOS, java for Java web, MobileCenter for App Center, Node.JS for Node.js, other for General, phone for Windows Phone, store for Windows Store and web for ASP.NET. Please note these values are case sensitive; unmatched values are treated as ASP.NET by Azure. Changing this forces a new resource to be created.
ResourceGroupName string: The name of the resource group in which to create the Application Insights component.
DailyDataCapInGb double: Specifies the Application Insights component daily data volume cap in GB.
DailyDataCapNotificationsDisabled bool: Specifies if a notification email will be send when the daily data volume cap is met.
DisableIpMasking bool: By default the real client ip is masked as 0.0.0.0 in the logs. Use this argument to disable masking and log the real client ip. Defaults to false.
Location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name string: Specifies the name of the Application Insights component. Changing this forces a new resource to be created.
RetentionInDays int: Specifies the retention period in days. Possible values are 30, 60, 90, 120, 180, 270, 365, 550 or 730. Defaults to 90.
SamplingPercentage double: Specifies the percentage of the data produced by the monitored application that is sampled for Application Insights telemetry.
Tags Dictionary<string, string>: A mapping of tags to assign to the resource.

ApplicationType string: Specifies the type of Application Insights to create. Valid values are ios for iOS, java for Java web, MobileCenter for App Center, Node.JS for Node.js, other for General, phone for Windows Phone, store for Windows Store and web for ASP.NET. Please note these values are case sensitive; unmatched values are treated as ASP.NET by Azure. Changing this forces a new resource to be created.
ResourceGroupName string: The name of the resource group in which to create the Application Insights component.
DailyDataCapInGb float64: Specifies the Application Insights component daily data volume cap in GB.
DailyDataCapNotificationsDisabled bool: Specifies if a notification email will be send when the daily data volume cap is met.
DisableIpMasking bool: By default the real client ip is masked as 0.0.0.0 in the logs. Use this argument to disable masking and log the real client ip. Defaults to false.
Location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name string: Specifies the name of the Application Insights component. Changing this forces a new resource to be created.
RetentionInDays int: Specifies the retention period in days. Possible values are 30, 60, 90, 120, 180, 270, 365, 550 or 730. Defaults to 90.
SamplingPercentage float64: Specifies the percentage of the data produced by the monitored application that is sampled for Application Insights telemetry.
Tags map[string]string: A mapping of tags to assign to the resource.

applicationType string: Specifies the type of Application Insights to create. Valid values are ios for iOS, java for Java web, MobileCenter for App Center, Node.JS for Node.js, other for General, phone for Windows Phone, store for Windows Store and web for ASP.NET. Please note these values are case sensitive; unmatched values are treated as ASP.NET by Azure. Changing this forces a new resource to be created.
resourceGroupName string: The name of the resource group in which to create the Application Insights component.
dailyDataCapInGb number: Specifies the Application Insights component daily data volume cap in GB.
dailyDataCapNotificationsDisabled boolean: Specifies if a notification email will be send when the daily data volume cap is met.
disableIpMasking boolean: By default the real client ip is masked as 0.0.0.0 in the logs. Use this argument to disable masking and log the real client ip. Defaults to false.
location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name string: Specifies the name of the Application Insights component. Changing this forces a new resource to be created.
retentionInDays number: Specifies the retention period in days. Possible values are 30, 60, 90, 120, 180, 270, 365, 550 or 730. Defaults to 90.
samplingPercentage number: Specifies the percentage of the data produced by the monitored application that is sampled for Application Insights telemetry.
tags {[key: string]: string}: A mapping of tags to assign to the resource.

application_type str: Specifies the type of Application Insights to create. Valid values are ios for iOS, java for Java web, MobileCenter for App Center, Node.JS for Node.js, other for General, phone for Windows Phone, store for Windows Store and web for ASP.NET. Please note these values are case sensitive; unmatched values are treated as ASP.NET by Azure. Changing this forces a new resource to be created.
resource_group_name str: The name of the resource group in which to create the Application Insights component.
daily_data_cap_in_gb float: Specifies the Application Insights component daily data volume cap in GB.
daily_data_cap_notifications_disabled bool: Specifies if a notification email will be send when the daily data volume cap is met.
disable_ip_masking bool: By default the real client ip is masked as 0.0.0.0 in the logs. Use this argument to disable masking and log the real client ip. Defaults to false.
location str: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name str: Specifies the name of the Application Insights component. Changing this forces a new resource to be created.
retention_in_days float: Specifies the retention period in days. Possible values are 30, 60, 90, 120, 180, 270, 365, 550 or 730. Defaults to 90.
sampling_percentage float: Specifies the percentage of the data produced by the monitored application that is sampled for Application Insights telemetry.
tags Dict[str, str]: A mapping of tags to assign to the resource.

Outputs

All input properties are implicitly available as output properties. Additionally, the Insights resource produces the following output properties:

AppId string: The App ID associated with this Application Insights component.
Id string: The provider-assigned unique ID for this managed resource.
InstrumentationKey string: The Instrumentation Key for this Application Insights component.

AppId string: The App ID associated with this Application Insights component.
Id string: The provider-assigned unique ID for this managed resource.
InstrumentationKey string: The Instrumentation Key for this Application Insights component.

appId string: The App ID associated with this Application Insights component.
id string: The provider-assigned unique ID for this managed resource.
instrumentationKey string: The Instrumentation Key for this Application Insights component.

app_id str: The App ID associated with this Application Insights component.
id str: The provider-assigned unique ID for this managed resource.
instrumentation_key str: The Instrumentation Key for this Application Insights component.

Look up an Existing Insights Resource

Get an existing Insights resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: InsightsState, opts?: CustomResourceOptions): Insights

static get(resource_name, id, opts=None, app_id=None, application_type=None, daily_data_cap_in_gb=None, daily_data_cap_notifications_disabled=None, disable_ip_masking=None, instrumentation_key=None, location=None, name=None, resource_group_name=None, retention_in_days=None, sampling_percentage=None, tags=None, __props__=None);

func GetInsights(ctx *Context, name string, id IDInput, state *InsightsState, opts ...ResourceOption) (*Insights, error)

public static Insights Get(string name, Input<string> id, InsightsState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

AppId string: The App ID associated with this Application Insights component.
ApplicationType string: Specifies the type of Application Insights to create. Valid values are ios for iOS, java for Java web, MobileCenter for App Center, Node.JS for Node.js, other for General, phone for Windows Phone, store for Windows Store and web for ASP.NET. Please note these values are case sensitive; unmatched values are treated as ASP.NET by Azure. Changing this forces a new resource to be created.
DailyDataCapInGb double: Specifies the Application Insights component daily data volume cap in GB.
DailyDataCapNotificationsDisabled bool: Specifies if a notification email will be send when the daily data volume cap is met.
DisableIpMasking bool: By default the real client ip is masked as 0.0.0.0 in the logs. Use this argument to disable masking and log the real client ip. Defaults to false.
InstrumentationKey string: The Instrumentation Key for this Application Insights component.
Location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name string: Specifies the name of the Application Insights component. Changing this forces a new resource to be created.
ResourceGroupName string: The name of the resource group in which to create the Application Insights component.
RetentionInDays int: Specifies the retention period in days. Possible values are 30, 60, 90, 120, 180, 270, 365, 550 or 730. Defaults to 90.
SamplingPercentage double: Specifies the percentage of the data produced by the monitored application that is sampled for Application Insights telemetry.
Tags Dictionary<string, string>: A mapping of tags to assign to the resource.

AppId string: The App ID associated with this Application Insights component.
ApplicationType string: Specifies the type of Application Insights to create. Valid values are ios for iOS, java for Java web, MobileCenter for App Center, Node.JS for Node.js, other for General, phone for Windows Phone, store for Windows Store and web for ASP.NET. Please note these values are case sensitive; unmatched values are treated as ASP.NET by Azure. Changing this forces a new resource to be created.
DailyDataCapInGb float64: Specifies the Application Insights component daily data volume cap in GB.
DailyDataCapNotificationsDisabled bool: Specifies if a notification email will be send when the daily data volume cap is met.
DisableIpMasking bool: By default the real client ip is masked as 0.0.0.0 in the logs. Use this argument to disable masking and log the real client ip. Defaults to false.
InstrumentationKey string: The Instrumentation Key for this Application Insights component.
Location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name string: Specifies the name of the Application Insights component. Changing this forces a new resource to be created.
ResourceGroupName string: The name of the resource group in which to create the Application Insights component.
RetentionInDays int: Specifies the retention period in days. Possible values are 30, 60, 90, 120, 180, 270, 365, 550 or 730. Defaults to 90.
SamplingPercentage float64: Specifies the percentage of the data produced by the monitored application that is sampled for Application Insights telemetry.
Tags map[string]string: A mapping of tags to assign to the resource.

appId string: The App ID associated with this Application Insights component.
applicationType string: Specifies the type of Application Insights to create. Valid values are ios for iOS, java for Java web, MobileCenter for App Center, Node.JS for Node.js, other for General, phone for Windows Phone, store for Windows Store and web for ASP.NET. Please note these values are case sensitive; unmatched values are treated as ASP.NET by Azure. Changing this forces a new resource to be created.
dailyDataCapInGb number: Specifies the Application Insights component daily data volume cap in GB.
dailyDataCapNotificationsDisabled boolean: Specifies if a notification email will be send when the daily data volume cap is met.
disableIpMasking boolean: By default the real client ip is masked as 0.0.0.0 in the logs. Use this argument to disable masking and log the real client ip. Defaults to false.
instrumentationKey string: The Instrumentation Key for this Application Insights component.
location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name string: Specifies the name of the Application Insights component. Changing this forces a new resource to be created.
resourceGroupName string: The name of the resource group in which to create the Application Insights component.
retentionInDays number: Specifies the retention period in days. Possible values are 30, 60, 90, 120, 180, 270, 365, 550 or 730. Defaults to 90.
samplingPercentage number: Specifies the percentage of the data produced by the monitored application that is sampled for Application Insights telemetry.
tags {[key: string]: string}: A mapping of tags to assign to the resource.

app_id str: The App ID associated with this Application Insights component.
application_type str: Specifies the type of Application Insights to create. Valid values are ios for iOS, java for Java web, MobileCenter for App Center, Node.JS for Node.js, other for General, phone for Windows Phone, store for Windows Store and web for ASP.NET. Please note these values are case sensitive; unmatched values are treated as ASP.NET by Azure. Changing this forces a new resource to be created.
daily_data_cap_in_gb float: Specifies the Application Insights component daily data volume cap in GB.
daily_data_cap_notifications_disabled bool: Specifies if a notification email will be send when the daily data volume cap is met.
disable_ip_masking bool: By default the real client ip is masked as 0.0.0.0 in the logs. Use this argument to disable masking and log the real client ip. Defaults to false.
instrumentation_key str: The Instrumentation Key for this Application Insights component.
location str: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name str: Specifies the name of the Application Insights component. Changing this forces a new resource to be created.
resource_group_name str: The name of the resource group in which to create the Application Insights component.
retention_in_days float: Specifies the retention period in days. Possible values are 30, 60, 90, 120, 180, 270, 365, 550 or 730. Defaults to 90.
sampling_percentage float: Specifies the percentage of the data produced by the monitored application that is sampled for Application Insights telemetry.
tags Dict[str, str]: A mapping of tags to assign to the resource.

Package Details

Repository: https://github.com/pulumi/pulumi-azure
License: Apache-2.0
Notes: This Pulumi package is based on the azurerm Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud