Module appinsights

This page documents the language specification for the azure package. If you're looking for help working with the inputs, outputs, or functions of azure resources in a Pulumi program, please see the resource documentation for examples and API reference.

Resources

Resource AnalyticsItem

class AnalyticsItem extends CustomResource

Manages an Application Insights Analytics Item component.

Example Usage

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: "West Europe",
    resourceGroupName: exampleResourceGroup.name,
    applicationType: "web",
});
const exampleAnalyticsItem = new azure.appinsights.AnalyticsItem("exampleAnalyticsItem", {
    applicationInsightsId: exampleInsights.id,
    content: "requests //simple example query",
    scope: "shared",
    type: "query",
});

constructor

new AnalyticsItem(name: string, args: AnalyticsItemArgs, opts?: pulumi.CustomResourceOptions)

Create a AnalyticsItem resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: AnalyticsItemState, opts?: pulumi.CustomResourceOptions): AnalyticsItem

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is AnalyticsItem

Returns true if the given object is an instance of AnalyticsItem. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property applicationInsightsId

public applicationInsightsId: pulumi.Output<string>;

The ID of the Application Insights component on which the Analytics Item exists. Changing this forces a new resource to be created.

property content

public content: pulumi.Output<string>;

The content for the Analytics Item, for example the query text if type is query.

property functionAlias

public functionAlias: pulumi.Output<string | undefined>;

The alias to use for the function. Required when type is function.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

Specifies the name of the Application Insights Analytics Item. Changing this forces a new resource to be created.

property scope

public scope: pulumi.Output<string>;

The scope for the Analytics Item. Can be shared or user. Changing this forces a new resource to be created. Must be shared for functions.

property timeCreated

public timeCreated: pulumi.Output<string>;

A string containing the time the Analytics Item was created.

property timeModified

public timeModified: pulumi.Output<string>;

A string containing the time the Analytics Item was last modified.

property type

public type: pulumi.Output<string>;

The type of Analytics Item to create. Can be one of query, function, folder, recent. Changing this forces a new resource to be created.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property version

public version: pulumi.Output<string>;

A string indicating the version of the query format

Resource ApiKey

class ApiKey extends CustomResource

Manages an Application Insights API key.

Example Usage

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: "West Europe",
    resourceGroupName: exampleResourceGroup.name,
    applicationType: "web",
});
const readTelemetry = new azure.appinsights.ApiKey("readTelemetry", {
    applicationInsightsId: exampleInsights.id,
    readPermissions: [
        "aggregate",
        "api",
        "draft",
        "extendqueries",
        "search",
    ],
});
const writeAnnotations = new azure.appinsights.ApiKey("writeAnnotations", {
    applicationInsightsId: exampleInsights.id,
    writePermissions: ["annotations"],
});
const authenticateSdkControlChannelApiKey = new azure.appinsights.ApiKey("authenticateSdkControlChannelApiKey", {
    applicationInsightsId: exampleInsights.id,
    readPermissions: ["agentconfig"],
});
const fullPermissions = new azure.appinsights.ApiKey("fullPermissions", {
    applicationInsightsId: exampleInsights.id,
    readPermissions: [
        "agentconfig",
        "aggregate",
        "api",
        "draft",
        "extendqueries",
        "search",
    ],
    writePermissions: ["annotations"],
});
export const readTelemetryApiKey = readTelemetry.apiKey;
export const writeAnnotationsApiKey = writeAnnotations.apiKey;
export const authenticateSdkControlChannel = authenticateSdkControlChannelApiKey.apiKey;
export const fullPermissionsApiKey = fullPermissions.apiKey;

constructor

new ApiKey(name: string, args: ApiKeyArgs, opts?: pulumi.CustomResourceOptions)

Create a ApiKey resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ApiKeyState, opts?: pulumi.CustomResourceOptions): ApiKey

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ApiKey

Returns true if the given object is an instance of ApiKey. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property apiKey

public apiKey: pulumi.Output<string>;

The API Key secret (Sensitive).

property applicationInsightsId

public applicationInsightsId: pulumi.Output<string>;

The ID of the Application Insights component on which the API key operates. Changing this forces a new resource to be created.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

Specifies the name of the Application Insights API key. Changing this forces a new resource to be created.

property readPermissions

public readPermissions: pulumi.Output<string[] | undefined>;

Specifies the list of read permissions granted to the API key. Valid values are agentconfig, aggregate, api, draft, extendqueries, search. Please note these values are case sensitive. Changing this forces a new resource to be created.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property writePermissions

public writePermissions: pulumi.Output<string[] | undefined>;

Specifies the list of write permissions granted to the API key. Valid values are annotations. Please note these values are case sensitive. Changing this forces a new resource to be created.

Resource Insights

class Insights extends CustomResource

Manages an Application Insights component.

Example Usage

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;

constructor

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

Create a Insights resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

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

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Insights

Returns true if the given object is an instance of Insights. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property appId

public appId: pulumi.Output<string>;

The App ID associated with this Application Insights component.

property applicationType

public applicationType: pulumi.Output<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.

property dailyDataCapInGb

public dailyDataCapInGb: pulumi.Output<number>;

Specifies the Application Insights component daily data volume cap in GB.

property dailyDataCapNotificationsDisabled

public dailyDataCapNotificationsDisabled: pulumi.Output<boolean>;

Specifies if a notification email will be send when the daily data volume cap is met.

property disableIpMasking

public disableIpMasking: pulumi.Output<boolean | undefined>;

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.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property instrumentationKey

public instrumentationKey: pulumi.Output<string>;

The Instrumentation Key for this Application Insights component.

property location

public location: pulumi.Output<string>;

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

property name

public name: pulumi.Output<string>;

Specifies the name of the Application Insights component. Changing this forces a new resource to be created.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

The name of the resource group in which to create the Application Insights component.

property retentionInDays

public retentionInDays: pulumi.Output<number | undefined>;

Specifies the retention period in days. Possible values are 30, 60, 90, 120, 180, 270, 365, 550 or 730. Defaults to 90.

property samplingPercentage

public samplingPercentage: pulumi.Output<number | undefined>;

Specifies the percentage of the data produced by the monitored application that is sampled for Application Insights telemetry.

property tags

public tags: pulumi.Output<{[key: string]: string} | undefined>;

A mapping of tags to assign to the resource.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource WebTest

class WebTest extends CustomResource

Manages an Application Insights WebTest.

constructor

new WebTest(name: string, args: WebTestArgs, opts?: pulumi.CustomResourceOptions)

Create a WebTest resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: WebTestState, opts?: pulumi.CustomResourceOptions): WebTest

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is WebTest

Returns true if the given object is an instance of WebTest. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property applicationInsightsId

public applicationInsightsId: pulumi.Output<string>;

The ID of the Application Insights component on which the WebTest operates. Changing this forces a new resource to be created.

property configuration

public configuration: pulumi.Output<string>;

An XML configuration specification for a WebTest.

property description

public description: pulumi.Output<string | undefined>;

Purpose/user defined descriptive test for this WebTest.

property enabled

public enabled: pulumi.Output<boolean | undefined>;

Is the test actively being monitored.

property frequency

public frequency: pulumi.Output<number | undefined>;

Interval in seconds between test runs for this WebTest. Default is 300.

property geoLocations

public geoLocations: pulumi.Output<string[]>;

A list of where to physically run the tests from to give global coverage for accessibility of your application.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property kind

public kind: pulumi.Output<string>;

= (Required) The kind of web test that this web test watches. Choices are ping and multistep.

property location

public location: pulumi.Output<string>;

The location of the resource group.

property name

public name: pulumi.Output<string>;

Specifies the name of the Application Insights WebTest. Changing this forces a new resource to be created.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

property retryEnabled

public retryEnabled: pulumi.Output<boolean | undefined>;

Allow for retries should this WebTest fail.

property syntheticMonitorId

public syntheticMonitorId: pulumi.Output<string>;

property tags

public tags: pulumi.Output<{[key: string]: string} | undefined>;

Resource tags.

property timeout

public timeout: pulumi.Output<number | undefined>;

Seconds until this WebTest will timeout and fail. Default is 30.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Functions

Function getInsights

getInsights(args: GetInsightsArgs, opts?: pulumi.InvokeOptions): Promise<GetInsightsResult>

Use this data source to access information about an existing Application Insights component.

Example Usage

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

const example = azure.appinsights.getInsights({
    name: "production",
    resourceGroupName: "networking",
});
export const applicationInsightsInstrumentationKey = example.then(example => example.instrumentationKey);

Others

interface AnalyticsItemArgs

interface AnalyticsItemArgs

The set of arguments for constructing a AnalyticsItem resource.

property applicationInsightsId

applicationInsightsId: pulumi.Input<string>;

The ID of the Application Insights component on which the Analytics Item exists. Changing this forces a new resource to be created.

property content

content: pulumi.Input<string>;

The content for the Analytics Item, for example the query text if type is query.

property functionAlias

functionAlias?: pulumi.Input<string>;

The alias to use for the function. Required when type is function.

property name

name?: pulumi.Input<string>;

Specifies the name of the Application Insights Analytics Item. Changing this forces a new resource to be created.

property scope

scope: pulumi.Input<string>;

The scope for the Analytics Item. Can be shared or user. Changing this forces a new resource to be created. Must be shared for functions.

property type

type: pulumi.Input<string>;

The type of Analytics Item to create. Can be one of query, function, folder, recent. Changing this forces a new resource to be created.

interface AnalyticsItemState

interface AnalyticsItemState

Input properties used for looking up and filtering AnalyticsItem resources.

property applicationInsightsId

applicationInsightsId?: pulumi.Input<string>;

The ID of the Application Insights component on which the Analytics Item exists. Changing this forces a new resource to be created.

property content

content?: pulumi.Input<string>;

The content for the Analytics Item, for example the query text if type is query.

property functionAlias

functionAlias?: pulumi.Input<string>;

The alias to use for the function. Required when type is function.

property name

name?: pulumi.Input<string>;

Specifies the name of the Application Insights Analytics Item. Changing this forces a new resource to be created.

property scope

scope?: pulumi.Input<string>;

The scope for the Analytics Item. Can be shared or user. Changing this forces a new resource to be created. Must be shared for functions.

property timeCreated

timeCreated?: pulumi.Input<string>;

A string containing the time the Analytics Item was created.

property timeModified

timeModified?: pulumi.Input<string>;

A string containing the time the Analytics Item was last modified.

property type

type?: pulumi.Input<string>;

The type of Analytics Item to create. Can be one of query, function, folder, recent. Changing this forces a new resource to be created.

property version

version?: pulumi.Input<string>;

A string indicating the version of the query format

interface ApiKeyArgs

interface ApiKeyArgs

The set of arguments for constructing a ApiKey resource.

property applicationInsightsId

applicationInsightsId: pulumi.Input<string>;

The ID of the Application Insights component on which the API key operates. Changing this forces a new resource to be created.

property name

name?: pulumi.Input<string>;

Specifies the name of the Application Insights API key. Changing this forces a new resource to be created.

property readPermissions

readPermissions?: pulumi.Input<pulumi.Input<string>[]>;

property writePermissions

writePermissions?: pulumi.Input<pulumi.Input<string>[]>;

Specifies the list of write permissions granted to the API key. Valid values are annotations. Please note these values are case sensitive. Changing this forces a new resource to be created.

interface ApiKeyState

interface ApiKeyState

Input properties used for looking up and filtering ApiKey resources.

property apiKey

apiKey?: pulumi.Input<string>;

The API Key secret (Sensitive).

property applicationInsightsId

applicationInsightsId?: pulumi.Input<string>;

The ID of the Application Insights component on which the API key operates. Changing this forces a new resource to be created.

property name

name?: pulumi.Input<string>;

Specifies the name of the Application Insights API key. Changing this forces a new resource to be created.

property readPermissions

readPermissions?: pulumi.Input<pulumi.Input<string>[]>;

property writePermissions

writePermissions?: pulumi.Input<pulumi.Input<string>[]>;

Specifies the list of write permissions granted to the API key. Valid values are annotations. Please note these values are case sensitive. Changing this forces a new resource to be created.

interface GetInsightsArgs

interface GetInsightsArgs

A collection of arguments for invoking getInsights.

property name

name: string;

Specifies the name of the Application Insights component.

property resourceGroupName

resourceGroupName: string;

Specifies the name of the resource group the Application Insights component is located in.

interface GetInsightsResult

interface GetInsightsResult

A collection of values returned by getInsights.

property appId

appId: string;

The App ID associated with this Application Insights component.

property applicationType

applicationType: string;

The type of the component.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property instrumentationKey

instrumentationKey: string;

The instrumentation key of the Application Insights component.

property location

location: string;

The Azure location where the component exists.

property name

name: string;

property resourceGroupName

resourceGroupName: string;

property retentionInDays

retentionInDays: number;

The retention period in days.

property tags

tags: {[key: string]: string};

Tags applied to the component.

interface InsightsArgs

interface InsightsArgs

The set of arguments for constructing a Insights resource.

property applicationType

applicationType: pulumi.Input<string>;

property dailyDataCapInGb

dailyDataCapInGb?: pulumi.Input<number>;

Specifies the Application Insights component daily data volume cap in GB.

property dailyDataCapNotificationsDisabled

dailyDataCapNotificationsDisabled?: pulumi.Input<boolean>;

Specifies if a notification email will be send when the daily data volume cap is met.

property disableIpMasking

disableIpMasking?: pulumi.Input<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.

property location

location?: pulumi.Input<string>;

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

property name

name?: pulumi.Input<string>;

Specifies the name of the Application Insights component. Changing this forces a new resource to be created.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

The name of the resource group in which to create the Application Insights component.

property retentionInDays

retentionInDays?: pulumi.Input<number>;

Specifies the retention period in days. Possible values are 30, 60, 90, 120, 180, 270, 365, 550 or 730. Defaults to 90.

property samplingPercentage

samplingPercentage?: pulumi.Input<number>;

Specifies the percentage of the data produced by the monitored application that is sampled for Application Insights telemetry.

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

interface InsightsState

interface InsightsState

Input properties used for looking up and filtering Insights resources.

property appId

appId?: pulumi.Input<string>;

The App ID associated with this Application Insights component.

property applicationType

applicationType?: pulumi.Input<string>;

property dailyDataCapInGb

dailyDataCapInGb?: pulumi.Input<number>;

Specifies the Application Insights component daily data volume cap in GB.

property dailyDataCapNotificationsDisabled

dailyDataCapNotificationsDisabled?: pulumi.Input<boolean>;

Specifies if a notification email will be send when the daily data volume cap is met.

property disableIpMasking

disableIpMasking?: pulumi.Input<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.

property instrumentationKey

instrumentationKey?: pulumi.Input<string>;

The Instrumentation Key for this Application Insights component.

property location

location?: pulumi.Input<string>;

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

property name

name?: pulumi.Input<string>;

Specifies the name of the Application Insights component. Changing this forces a new resource to be created.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

The name of the resource group in which to create the Application Insights component.

property retentionInDays

retentionInDays?: pulumi.Input<number>;

Specifies the retention period in days. Possible values are 30, 60, 90, 120, 180, 270, 365, 550 or 730. Defaults to 90.

property samplingPercentage

samplingPercentage?: pulumi.Input<number>;

Specifies the percentage of the data produced by the monitored application that is sampled for Application Insights telemetry.

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

interface WebTestArgs

interface WebTestArgs

The set of arguments for constructing a WebTest resource.

property applicationInsightsId

applicationInsightsId: pulumi.Input<string>;

The ID of the Application Insights component on which the WebTest operates. Changing this forces a new resource to be created.

property configuration

configuration: pulumi.Input<string>;

An XML configuration specification for a WebTest.

property description

description?: pulumi.Input<string>;

Purpose/user defined descriptive test for this WebTest.

property enabled

enabled?: pulumi.Input<boolean>;

Is the test actively being monitored.

property frequency

frequency?: pulumi.Input<number>;

Interval in seconds between test runs for this WebTest. Default is 300.

property geoLocations

geoLocations: pulumi.Input<pulumi.Input<string>[]>;

A list of where to physically run the tests from to give global coverage for accessibility of your application.

property kind

kind: pulumi.Input<string>;

= (Required) The kind of web test that this web test watches. Choices are ping and multistep.

property location

location?: pulumi.Input<string>;

The location of the resource group.

property name

name?: pulumi.Input<string>;

Specifies the name of the Application Insights WebTest. Changing this forces a new resource to be created.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

property retryEnabled

retryEnabled?: pulumi.Input<boolean>;

Allow for retries should this WebTest fail.

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

Resource tags.

property timeout

timeout?: pulumi.Input<number>;

Seconds until this WebTest will timeout and fail. Default is 30.

interface WebTestState

interface WebTestState

Input properties used for looking up and filtering WebTest resources.

property applicationInsightsId

applicationInsightsId?: pulumi.Input<string>;

The ID of the Application Insights component on which the WebTest operates. Changing this forces a new resource to be created.

property configuration

configuration?: pulumi.Input<string>;

An XML configuration specification for a WebTest.

property description

description?: pulumi.Input<string>;

Purpose/user defined descriptive test for this WebTest.

property enabled

enabled?: pulumi.Input<boolean>;

Is the test actively being monitored.

property frequency

frequency?: pulumi.Input<number>;

Interval in seconds between test runs for this WebTest. Default is 300.

property geoLocations

geoLocations?: pulumi.Input<pulumi.Input<string>[]>;

A list of where to physically run the tests from to give global coverage for accessibility of your application.

property kind

kind?: pulumi.Input<string>;

= (Required) The kind of web test that this web test watches. Choices are ping and multistep.

property location

location?: pulumi.Input<string>;

The location of the resource group.

property name

name?: pulumi.Input<string>;

Specifies the name of the Application Insights WebTest. Changing this forces a new resource to be created.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

property retryEnabled

retryEnabled?: pulumi.Input<boolean>;

Allow for retries should this WebTest fail.

property syntheticMonitorId

syntheticMonitorId?: pulumi.Input<string>;

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

Resource tags.

property timeout

timeout?: pulumi.Input<number>;

Seconds until this WebTest will timeout and fail. Default is 30.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

Module appinsights

Resources

Functions

Others

Resources

Example Usage

Example Usage

Example Usage

Functions

Example Usage

Others