ApplicationInsightsComponentProperties interface
Properties that define an Application Insights component resource.
Properties
| app |
Application Insights Unique ID for your Application. |
| application |
The unique ID of your application. This field mirrors the 'Name' field and cannot be changed. |
| application |
Type of application being monitored. |
| connection |
Application Insights component connection string. |
| creation |
Creation Date for the Application Insights component, in ISO 8601 format. |
| disable |
Disable IP masking. |
| disable |
Disable Non-AAD based Auth. |
| flow |
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. |
| force |
Force users to create their own storage account for profiler and debugger. |
| hockey |
The unique application ID created when a new application is added to HockeyApp, used for communications with HockeyApp. |
| hockey |
Token used to authenticate communications with between Application Insights and HockeyApp. |
| immediate |
Purge data immediately after 30 days. |
| ingestion |
Indicates the flow of the ingestion. |
| instrumentation |
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. |
| la |
The date which the component got migrated to LA, in ISO 8601 format. |
| name | Application name. |
| private |
List of linked private link scope resources. |
| provisioning |
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. |
| public |
The network access type for accessing Application Insights ingestion. |
| public |
The network access type for accessing Application Insights query. |
| request |
Describes what tool created this Application Insights component. Customers using this API should set this to the default 'rest'. |
| retention |
Retention period in days. |
| sampling |
Percentage of the data produced by the application being monitored that is being sampled for Application Insights telemetry. |
| tenant |
Azure Tenant Id. |
| workspace |
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. |
Property Details
appId
Application Insights Unique ID for your Application.
appId?: stringProperty Value
string
applicationId
The unique ID of your application. This field mirrors the 'Name' field and cannot be changed.
applicationId?: stringProperty Value
string
applicationType
Type of application being monitored.
applicationType: stringProperty Value
string
connectionString
Application Insights component connection string.
connectionString?: stringProperty Value
string
creationDate
Creation Date for the Application Insights component, in ISO 8601 format.
creationDate?: DateProperty Value
Date
disableIpMasking
Disable IP masking.
disableIpMasking?: booleanProperty Value
boolean
disableLocalAuth
Disable Non-AAD based Auth.
disableLocalAuth?: booleanProperty Value
boolean
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?: stringProperty Value
string
forceCustomerStorageForProfiler
Force users to create their own storage account for profiler and debugger.
forceCustomerStorageForProfiler?: booleanProperty Value
boolean
hockeyAppId
The unique application ID created when a new application is added to HockeyApp, used for communications with HockeyApp.
hockeyAppId?: stringProperty Value
string
hockeyAppToken
Token used to authenticate communications with between Application Insights and HockeyApp.
hockeyAppToken?: stringProperty Value
string
immediatePurgeDataOn30Days
Purge data immediately after 30 days.
immediatePurgeDataOn30Days?: booleanProperty Value
boolean
ingestionMode
Indicates the flow of the ingestion.
ingestionMode?: stringProperty 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.
instrumentationKey?: stringProperty Value
string
laMigrationDate
The date which the component got migrated to LA, in ISO 8601 format.
laMigrationDate?: DateProperty Value
Date
name
Application name.
name?: stringProperty Value
string
privateLinkScopedResources
List of linked private link scope resources.
privateLinkScopedResources?: PrivateLinkScopedResource[]Property Value
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.
provisioningState?: stringProperty Value
string
publicNetworkAccessForIngestion
The network access type for accessing Application Insights ingestion.
publicNetworkAccessForIngestion?: stringProperty Value
string
publicNetworkAccessForQuery
The network access type for accessing Application Insights query.
publicNetworkAccessForQuery?: stringProperty Value
string
requestSource
Describes what tool created this Application Insights component. Customers using this API should set this to the default 'rest'.
requestSource?: stringProperty Value
string
retentionInDays
Retention period in days.
retentionInDays?: numberProperty Value
number
samplingPercentage
Percentage of the data produced by the application being monitored that is being sampled for Application Insights telemetry.
samplingPercentage?: numberProperty Value
number
tenantId
Azure Tenant Id.
tenantId?: stringProperty 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?: stringProperty Value
string
