Share via

ApplicationInsightsComponent interface

  • Reference
Package:
@azure/arm-appinsights

An Application Insights component definition.

Extends
ComponentsResource

Properties

appId

Application Insights Unique ID for your Application. NOTE: This property will not be serialized. It can only be populated by the server.
applicationId

The unique ID of your application. This field mirrors the 'Name' field and cannot be changed. NOTE: This property will not be serialized. It can only be populated by the server.
applicationType

Type of application being monitored.
connectionString

Application Insights component connection string. NOTE: This property will not be serialized. It can only be populated by the server.
creationDate

Creation Date for the Application Insights component, in ISO 8601 format. NOTE: This property will not be serialized. It can only be populated by the server.
disableIpMasking

Disable IP masking.
disableLocalAuth

Disable Non-AAD based Auth.
etag

Resource etag
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.
forceCustomerStorageForProfiler

Force users to create their own storage account for profiler and debugger.
hockeyAppId

The unique application ID created when a new application is added to HockeyApp, used for communications with HockeyApp.
hockeyAppToken

Token used to authenticate communications with between Application Insights and HockeyApp. NOTE: This property will not be serialized. It can only be populated by the server.
immediatePurgeDataOn30Days

Purge data immediately after 30 days.
ingestionMode

Indicates the flow of the ingestion.
instrumentationKey

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. NOTE: This property will not be serialized. It can only be populated by the server.
kind

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.
laMigrationDate

The date which the component got migrated to LA, in ISO 8601 format. NOTE: This property will not be serialized. It can only be populated by the server.
namePropertiesName

Application name. NOTE: This property will not be serialized. It can only be populated by the server.
privateLinkScopedResources

List of linked private link scope resources. NOTE: This property will not be serialized. It can only be populated by the server.
provisioningState

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. NOTE: This property will not be serialized. It can only be populated by the server.
publicNetworkAccessForIngestion

The network access type for accessing Application Insights ingestion.
publicNetworkAccessForQuery

The network access type for accessing Application Insights query.
requestSource

Describes what tool created this Application Insights component. Customers using this API should set this to the default 'rest'.
retentionInDays

Retention period in days.
samplingPercentage

Percentage of the data produced by the application being monitored that is being sampled for Application Insights telemetry.
tenantId

Azure Tenant Id. NOTE: This property will not be serialized. It can only be populated by the server.
workspaceResourceId

Resource Id of the log analytics workspace which the data will be ingested to. This property is required to create an application with this API version. Applications from older versions will not have this property.

Inherited Properties

id

Azure resource Id NOTE: This property will not be serialized. It can only be populated by the server.
location

Resource location
name

Azure resource name NOTE: This property will not be serialized. It can only be populated by the server.
tags

Resource tags
type

Azure resource type NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

appId

Application Insights Unique ID for your Application. NOTE: This property will not be serialized. It can only be populated by the server.

appId?: string

Property Value

string

applicationId

The unique ID of your application. This field mirrors the 'Name' field and cannot be changed. NOTE: This property will not be serialized. It can only be populated by the server.

applicationId?: string

Property Value

string

applicationType

Type of application being monitored.

applicationType?: string

Property Value

string

connectionString

Application Insights component connection string. NOTE: This property will not be serialized. It can only be populated by the server.

connectionString?: string

Property Value

string

creationDate

Creation Date for the Application Insights component, in ISO 8601 format. NOTE: This property will not be serialized. It can only be populated by the server.

creationDate?: Date

Property Value

Date

disableIpMasking

Disable IP masking.

disableIpMasking?: boolean

Property Value

boolean

disableLocalAuth

Disable Non-AAD based Auth.

disableLocalAuth?: boolean

Property Value

boolean

etag

Resource etag

etag?: string

Property Value

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.

flowType?: string

Property Value

string

forceCustomerStorageForProfiler

Force users to create their own storage account for profiler and debugger.

forceCustomerStorageForProfiler?: boolean

Property Value

boolean

hockeyAppId

The unique application ID created when a new application is added to HockeyApp, used for communications with HockeyApp.

hockeyAppId?: string

Property Value

string

hockeyAppToken

Token used to authenticate communications with between Application Insights and HockeyApp. NOTE: This property will not be serialized. It can only be populated by the server.

hockeyAppToken?: string

Property Value

string

immediatePurgeDataOn30Days

Purge data immediately after 30 days.

immediatePurgeDataOn30Days?: boolean

Property Value

boolean

ingestionMode

Indicates the flow of the ingestion.

ingestionMode?: string

Property Value

string

instrumentationKey

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. NOTE: This property will not be serialized. It can only be populated by the server.

instrumentationKey?: string

Property Value

string

kind

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.

kind: string

Property Value

string

laMigrationDate

The date which the component got migrated to LA, in ISO 8601 format. NOTE: This property will not be serialized. It can only be populated by the server.

laMigrationDate?: Date

Property Value

Date

namePropertiesName

Application name. NOTE: This property will not be serialized. It can only be populated by the server.

namePropertiesName?: string

Property Value

string

privateLinkScopedResources

List of linked private link scope resources. NOTE: This property will not be serialized. It can only be populated by the server.

privateLinkScopedResources?: PrivateLinkScopedResource[]

Property Value

PrivateLinkScopedResource[]

provisioningState

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. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

publicNetworkAccessForIngestion

The network access type for accessing Application Insights ingestion.

publicNetworkAccessForIngestion?: string

Property Value

string

publicNetworkAccessForQuery

The network access type for accessing Application Insights query.

publicNetworkAccessForQuery?: string

Property Value

string

requestSource

Describes what tool created this Application Insights component. Customers using this API should set this to the default 'rest'.

requestSource?: string

Property Value

string

retentionInDays

Retention period in days.

retentionInDays?: number

Property Value

number

samplingPercentage

Percentage of the data produced by the application being monitored that is being sampled for Application Insights telemetry.

samplingPercentage?: number

Property Value

number

tenantId

Azure Tenant Id. NOTE: This property will not be serialized. It can only be populated by the server.

tenantId?: string

Property Value

string

workspaceResourceId

Resource Id of the log analytics workspace which the data will be ingested to. This property is required to create an application with this API version. Applications from older versions will not have this property.

workspaceResourceId?: string

Property Value

string

Inherited Property Details

id

Azure resource Id NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From ComponentsResource.id

location

Resource location

location: string

Property Value

string

Inherited From ComponentsResource.location

name

Azure resource name NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From ComponentsResource.name

tags

Resource tags

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

Inherited From ComponentsResource.tags

type

Azure resource type NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From ComponentsResource.type