Bicep Module Documentation
← Back to Overview
Module application-insights
applicationInsights
| Property | Value | Description |
|---|---|---|
| general (required) | general | |
| 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. (default: web) |
| applicationType | 'other' 'web' |
Type of application being monitored. (default: web) |
| disableIpMasking | bool | Disable IP masking. |
| disableLocalAuth | bool | Disable Non-AAD based Auth. |
| forceCustomerStorageForProfiler | bool | Force users to create their own storage account for profiler and debugger. |
| 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 | 'ApplicationInsights' 'ApplicationInsightsWithDiagnosticSettings' 'LogAnalytics' |
Indicates the flow of the ingestion. (default: LogAnalytics) |
| publicNetworkAccessForIngestion | 'Disabled' 'Enabled' |
The network access type for accessing Application Insights ingestion. (default: enabled) |
| publicNetworkAccessForQuery | 'Disabled' 'Enabled' |
The network access type for accessing Application Insights query. (default: enabled) |
| retentionInDays | int | Retention period in days. (default: 90) |
| samplingPercentage | int | Percentage of the data produced by the application being monitored that is being sampled for Application Insights telemetry. Specify a decimal value |
| workspaceResourceId (required) | string | 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. |
naming
| Property | Value | Description |
|---|---|---|
| forceFunctionAsFullName | bool | Use the function value as the full name of the resource |
| abbreviation | string | Override the abbreviation of this resource with this parameter |
| environment | string | The resource environment (for example: dev, tst, acc, prd) |
| location | string | The resource location (for example: weu, we, westeurope) |
| customer | string | The name of the customer |
| delimiter | string | The delimiter between resources (default: -) |
| nameFormat | Array containing any of: 'abbreviation' 'customer' 'environment' 'function' 'location' 'param1' 'param2' 'param3' 'useCaseName' |
The order of the array defines the order of elements in the naming scheme |
| param1 | string | Extra parameter self defined |
| param2 | string | Extra parameter self defined |
| param3 | string | Extra parameter self defined |
| function (required) | string | Function of the resource [can be app, db, security,...] |
| useCaseName | string | Name of the use case [can be hub, spoke,...] |
| suffix | string | Suffix for the resource, if empty non will be appended, otherwise will be added to the end [can be index, ...] |
| forceDefaultNaming | bool | Force the CAF naming instead of default company naming |
resourceLock
| Property | Value | Description |
|---|---|---|
| name | string | Character limit: 1-90. Valid characters: Alphanumerics, periods, underscores, hyphens, and parenthesis. Can't end in period. |
| level (required) | 'CanNotDelete' 'ReadOnly' |
The level of the lock. Possible values are: CanNotDelete and ReadOnly. CanNotDelete means authorized users are able to read and modify the resources, but not delete. ReadOnly means authorized users can only read from a resource, but they can't modify or delete it. Read-Only locks must be commented to be able to deploy again |
| notes | string | Notes about the lock. Maximum of 512 characters. |
| owners | resourceLockOwner[] | The owners of the lock |
resourceLockOwner
| Property | Value | Description |
|---|---|---|
| applicationId (required) | string | The application ID of the lock owner. |
roleAssignment
| Property | Value | Description |
|---|---|---|
| principalId (required) | string | The principal ID |
| roleDefinitionId (required) | string | The role definition ID, data file can be used for this |
| condition | string | Condition on the role assignment |
| conditionVersion | string | Version of the condition. Currently the only accepted value is "2.0" |
| delegatedManagedIdentityResourceId | string | Id of the delegated managed identity resource |
| description | string | Description of role assignment |
general
| Property | Value | Description |
|---|---|---|
| tags | object | Tags of the resource [hashtable] |
| location (required) | string | Location of the resource |
| naming (required) | naming | Naming module of the resource |
| resourceGroupName (required) | string | Name of the resource group where the resource should be located |
| sharedNaming (required) | naming | Reference to the default naming |
| roleAssignments | roleAssignment[] | Role assignments on the resource |
| resourceLocks | resourceLock[] | Resource Locks on the resource |
Changelog
3.0.1 (2025-09-24)
Bug Fixes
- remove deployment name + cleanup
3.0.0 (2025-09-24)
⚠ BREAKING CHANGES
- remove deprecated outputs
Bug Fixes
- remove deprecated outputs
2.1.1 (2025-04-11)
Bug Fixes
- naming connected resources when forceFunctionAsFullName or forceDefaultNaming is true
2.1.0 (2025-03-26)
Features
- add resourceName output
2.0.0 (2025-03-17)
⚠ BREAKING CHANGES
- remove role-assignment principalType parameter
Features
- remove role-assignment principalType parameter