Welcome to Pulumi Registry, your window into the cloud. Read the announcement.

Azure Native

v1.42.0 published on Monday, Oct 25, 2021 by Pulumi

Component

An Application Insights component definition. API Version: 2015-05-01.

Example Usage

ComponentCreate

using Pulumi;
using AzureNative = Pulumi.AzureNative;

class MyStack : Stack
{
    public MyStack()
    {
        var component = new AzureNative.Insights.Component("component", new AzureNative.Insights.ComponentArgs
        {
            ApplicationType = "web",
            FlowType = "Bluefield",
            Kind = "web",
            Location = "South Central US",
            RequestSource = "rest",
            ResourceGroupName = "my-resource-group",
            ResourceName = "my-component",
        });
    }

}

package main

import (
	insights "github.com/pulumi/pulumi-azure-native/sdk/go/azure/insights"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := insights.NewComponent(ctx, "component", &insights.ComponentArgs{
			ApplicationType:   pulumi.String("web"),
			FlowType:          pulumi.String("Bluefield"),
			Kind:              pulumi.String("web"),
			Location:          pulumi.String("South Central US"),
			RequestSource:     pulumi.String("rest"),
			ResourceGroupName: pulumi.String("my-resource-group"),
			ResourceName:      pulumi.String("my-component"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

import pulumi
import pulumi_azure_native as azure_native

component = azure_native.insights.Component("component",
    application_type="web",
    flow_type="Bluefield",
    kind="web",
    location="South Central US",
    request_source="rest",
    resource_group_name="my-resource-group",
    resource_name="my-component")

import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const component = new azure_native.insights.Component("component", {
    applicationType: "web",
    flowType: "Bluefield",
    kind: "web",
    location: "South Central US",
    requestSource: "rest",
    resourceGroupName: "my-resource-group",
    resourceName: "my-component",
});

ComponentUpdate

using Pulumi;
using AzureNative = Pulumi.AzureNative;

class MyStack : Stack
{
    public MyStack()
    {
        var component = new AzureNative.Insights.Component("component", new AzureNative.Insights.ComponentArgs
        {
            Kind = "web",
            Location = "South Central US",
            ResourceGroupName = "my-resource-group",
            ResourceName = "my-component",
            Tags = 
            {
                { "ApplicationGatewayType", "Internal-Only" },
                { "BillingEntity", "Self" },
            },
        });
    }

}

package main

import (
	insights "github.com/pulumi/pulumi-azure-native/sdk/go/azure/insights"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := insights.NewComponent(ctx, "component", &insights.ComponentArgs{
			Kind:              pulumi.String("web"),
			Location:          pulumi.String("South Central US"),
			ResourceGroupName: pulumi.String("my-resource-group"),
			ResourceName:      pulumi.String("my-component"),
			Tags: pulumi.StringMap{
				"ApplicationGatewayType": pulumi.String("Internal-Only"),
				"BillingEntity":          pulumi.String("Self"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

import pulumi
import pulumi_azure_native as azure_native

component = azure_native.insights.Component("component",
    kind="web",
    location="South Central US",
    resource_group_name="my-resource-group",
    resource_name="my-component",
    tags={
        "ApplicationGatewayType": "Internal-Only",
        "BillingEntity": "Self",
    })

import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const component = new azure_native.insights.Component("component", {
    kind: "web",
    location: "South Central US",
    resourceGroupName: "my-resource-group",
    resourceName: "my-component",
    tags: {
        ApplicationGatewayType: "Internal-Only",
        BillingEntity: "Self",
    },
});

Create a Component Resource

new Component(name: string, args: ComponentArgs, opts?: CustomResourceOptions);
@overload
def Component(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              application_type: Optional[Union[str, ApplicationType]] = None,
              disable_ip_masking: Optional[bool] = None,
              flow_type: Optional[Union[str, FlowType]] = None,
              hockey_app_id: Optional[str] = None,
              immediate_purge_data_on30_days: Optional[bool] = None,
              ingestion_mode: Optional[Union[str, IngestionMode]] = None,
              kind: Optional[str] = None,
              location: Optional[str] = None,
              request_source: Optional[Union[str, RequestSource]] = None,
              resource_group_name: Optional[str] = None,
              resource_name_: Optional[str] = None,
              retention_in_days: Optional[int] = None,
              sampling_percentage: Optional[float] = None,
              tags: Optional[Mapping[str, str]] = None)
@overload
def Component(resource_name: str,
              args: ComponentArgs,
              opts: Optional[ResourceOptions] = None)
func NewComponent(ctx *Context, name string, args ComponentArgs, opts ...ResourceOption) (*Component, error)
public Component(string name, ComponentArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args ComponentArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args ComponentArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args ComponentArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args ComponentArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

Component Resource Properties

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

Inputs

The Component resource accepts the following input properties:

ApplicationType string | Pulumi.AzureNative.Insights.ApplicationType
Type of application being monitored.
Kind string
The kind of application that this component refers to, used to customize UI. This value is a freeform string, values should typically be one of the following: web, ios, other, store, java, phone.
ResourceGroupName string
The name of the resource group. The name is case insensitive.
DisableIpMasking bool
Disable IP masking.
FlowType string | Pulumi.AzureNative.Insights.FlowType
Used by the Application Insights system to determine what kind of flow this component was created by. This is to be set to ‘Bluefield’ when creating/updating a component via the REST API.
HockeyAppId string
The unique application ID created when a new application is added to HockeyApp, used for communications with HockeyApp.
ImmediatePurgeDataOn30Days bool
Purge data immediately after 30 days.
IngestionMode string | Pulumi.AzureNative.Insights.IngestionMode
Indicates the flow of the ingestion.
Location string
Resource location
RequestSource string | Pulumi.AzureNative.Insights.RequestSource
Describes what tool created this Application Insights component. Customers using this API should set this to the default ‘rest’.
ResourceName string
The name of the Application Insights component resource.
RetentionInDays int
Retention period in days.
SamplingPercentage double
Percentage of the data produced by the application being monitored that is being sampled for Application Insights telemetry.
Tags Dictionary<string, string>
Resource tags
ApplicationType string | ApplicationType
Type of application being monitored.
Kind string
The kind of application that this component refers to, used to customize UI. This value is a freeform string, values should typically be one of the following: web, ios, other, store, java, phone.
ResourceGroupName string
The name of the resource group. The name is case insensitive.
DisableIpMasking bool
Disable IP masking.
FlowType string | FlowType
Used by the Application Insights system to determine what kind of flow this component was created by. This is to be set to ‘Bluefield’ when creating/updating a component via the REST API.
HockeyAppId string
The unique application ID created when a new application is added to HockeyApp, used for communications with HockeyApp.
ImmediatePurgeDataOn30Days bool
Purge data immediately after 30 days.
IngestionMode string | IngestionMode
Indicates the flow of the ingestion.
Location string
Resource location
RequestSource string | RequestSource
Describes what tool created this Application Insights component. Customers using this API should set this to the default ‘rest’.
ResourceName string
The name of the Application Insights component resource.
RetentionInDays int
Retention period in days.
SamplingPercentage float64
Percentage of the data produced by the application being monitored that is being sampled for Application Insights telemetry.
Tags map[string]string
Resource tags
applicationType string | ApplicationType
Type of application being monitored.
kind string
The kind of application that this component refers to, used to customize UI. This value is a freeform string, values should typically be one of the following: web, ios, other, store, java, phone.
resourceGroupName string
The name of the resource group. The name is case insensitive.
disableIpMasking boolean
Disable IP masking.
flowType string | FlowType
Used by the Application Insights system to determine what kind of flow this component was created by. This is to be set to ‘Bluefield’ when creating/updating a component via the REST API.
hockeyAppId string
The unique application ID created when a new application is added to HockeyApp, used for communications with HockeyApp.
immediatePurgeDataOn30Days boolean
Purge data immediately after 30 days.
ingestionMode string | IngestionMode
Indicates the flow of the ingestion.
location string
Resource location
requestSource string | RequestSource
Describes what tool created this Application Insights component. Customers using this API should set this to the default ‘rest’.
resourceName string
The name of the Application Insights component resource.
retentionInDays number
Retention period in days.
samplingPercentage number
Percentage of the data produced by the application being monitored that is being sampled for Application Insights telemetry.
tags {[key: string]: string}
Resource tags
application_type str | ApplicationType
Type of application being monitored.
kind str
The kind of application that this component refers to, used to customize UI. This value is a freeform string, values should typically be one of the following: web, ios, other, store, java, phone.
resource_group_name str
The name of the resource group. The name is case insensitive.
disable_ip_masking bool
Disable IP masking.
flow_type str | FlowType
Used by the Application Insights system to determine what kind of flow this component was created by. This is to be set to ‘Bluefield’ when creating/updating a component via the REST API.
hockey_app_id str
The unique application ID created when a new application is added to HockeyApp, used for communications with HockeyApp.
immediate_purge_data_on30_days bool
Purge data immediately after 30 days.
ingestion_mode str | IngestionMode
Indicates the flow of the ingestion.
location str
Resource location
request_source str | RequestSource
Describes what tool created this Application Insights component. Customers using this API should set this to the default ‘rest’.
resource_name str
The name of the Application Insights component resource.
retention_in_days int
Retention period in days.
sampling_percentage float
Percentage of the data produced by the application being monitored that is being sampled for Application Insights telemetry.
tags Mapping[str, str]
Resource tags

Outputs

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

AppId string
Application Insights Unique ID for your Application.
ApplicationId string
The unique ID of your application. This field mirrors the ‘Name’ field and cannot be changed.
ConnectionString string
Application Insights component connection string.
CreationDate string
Creation Date for the Application Insights component, in ISO 8601 format.
HockeyAppToken string
Token used to authenticate communications with between Application Insights and HockeyApp.
Id string
The provider-assigned unique ID for this managed resource.
InstrumentationKey string
Application Insights Instrumentation key. A read-only value that applications can use to identify the destination for all telemetry sent to Azure Application Insights. This value will be supplied upon construction of each new Application Insights component.
Name string
Azure resource name
PrivateLinkScopedResources List<Pulumi.AzureNative.Insights.Outputs.PrivateLinkScopedResourceResponse>
List of linked private link scope resources.
ProvisioningState string
Current state of this component: whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it. Values will include Succeeded, Deploying, Canceled, and Failed.
TenantId string
Azure Tenant Id.
Type string
Azure resource type
AppId string
Application Insights Unique ID for your Application.
ApplicationId string
The unique ID of your application. This field mirrors the ‘Name’ field and cannot be changed.
ConnectionString string
Application Insights component connection string.
CreationDate string
Creation Date for the Application Insights component, in ISO 8601 format.
HockeyAppToken string
Token used to authenticate communications with between Application Insights and HockeyApp.
Id string
The provider-assigned unique ID for this managed resource.
InstrumentationKey string
Application Insights Instrumentation key. A read-only value that applications can use to identify the destination for all telemetry sent to Azure Application Insights. This value will be supplied upon construction of each new Application Insights component.
Name string
Azure resource name
PrivateLinkScopedResources []PrivateLinkScopedResourceResponse
List of linked private link scope resources.
ProvisioningState string
Current state of this component: whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it. Values will include Succeeded, Deploying, Canceled, and Failed.
TenantId string
Azure Tenant Id.
Type string
Azure resource type
appId string
Application Insights Unique ID for your Application.
applicationId string
The unique ID of your application. This field mirrors the ‘Name’ field and cannot be changed.
connectionString string
Application Insights component connection string.
creationDate string
Creation Date for the Application Insights component, in ISO 8601 format.
hockeyAppToken string
Token used to authenticate communications with between Application Insights and HockeyApp.
id string
The provider-assigned unique ID for this managed resource.
instrumentationKey string
Application Insights Instrumentation key. A read-only value that applications can use to identify the destination for all telemetry sent to Azure Application Insights. This value will be supplied upon construction of each new Application Insights component.
name string
Azure resource name
privateLinkScopedResources PrivateLinkScopedResourceResponse[]
List of linked private link scope resources.
provisioningState string
Current state of this component: whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it. Values will include Succeeded, Deploying, Canceled, and Failed.
tenantId string
Azure Tenant Id.
type string
Azure resource type
app_id str
Application Insights Unique ID for your Application.
application_id str
The unique ID of your application. This field mirrors the ‘Name’ field and cannot be changed.
connection_string str
Application Insights component connection string.
creation_date str
Creation Date for the Application Insights component, in ISO 8601 format.
hockey_app_token str
Token used to authenticate communications with between Application Insights and HockeyApp.
id str
The provider-assigned unique ID for this managed resource.
instrumentation_key str
Application Insights Instrumentation key. A read-only value that applications can use to identify the destination for all telemetry sent to Azure Application Insights. This value will be supplied upon construction of each new Application Insights component.
name str
Azure resource name
private_link_scoped_resources Sequence[PrivateLinkScopedResourceResponse]
List of linked private link scope resources.
provisioning_state str
Current state of this component: whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it. Values will include Succeeded, Deploying, Canceled, and Failed.
tenant_id str
Azure Tenant Id.
type str
Azure resource type

Supporting Types

ApplicationType

Web
web
Other
other
ApplicationTypeWeb
web
ApplicationTypeOther
other
Web
web
Other
other
WEB
web
OTHER
other

FlowType

Bluefield
Bluefield
FlowTypeBluefield
Bluefield
Bluefield
Bluefield
BLUEFIELD
Bluefield

IngestionMode

ApplicationInsights
ApplicationInsights
ApplicationInsightsWithDiagnosticSettings
ApplicationInsightsWithDiagnosticSettings
LogAnalytics
LogAnalytics
IngestionModeApplicationInsights
ApplicationInsights
IngestionModeApplicationInsightsWithDiagnosticSettings
ApplicationInsightsWithDiagnosticSettings
IngestionModeLogAnalytics
LogAnalytics
ApplicationInsights
ApplicationInsights
ApplicationInsightsWithDiagnosticSettings
ApplicationInsightsWithDiagnosticSettings
LogAnalytics
LogAnalytics
APPLICATION_INSIGHTS
ApplicationInsights
APPLICATION_INSIGHTS_WITH_DIAGNOSTIC_SETTINGS
ApplicationInsightsWithDiagnosticSettings
LOG_ANALYTICS
LogAnalytics

PrivateLinkScopedResourceResponse

ResourceId string
The full resource Id of the private link scope resource.
ScopeId string
The private link scope unique Identifier.
ResourceId string
The full resource Id of the private link scope resource.
ScopeId string
The private link scope unique Identifier.
resourceId string
The full resource Id of the private link scope resource.
scopeId string
The private link scope unique Identifier.
resource_id str
The full resource Id of the private link scope resource.
scope_id str
The private link scope unique Identifier.

RequestSource

Rest
rest
RequestSourceRest
rest
Rest
rest
REST
rest

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:insights:Component my-component /subscriptions/subid/resourceGroups/my-resource-group/providers/Microsoft.Insights/components/my-component 

Package Details

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