terraform-azurerm-avm-res-insights-component

Important

As the overall AVM framework is not GA (generally available) yet - the CI framework and test automation is not fully functional and implemented across all supported languages yet - breaking changes are expected, and additional customer feedback is yet to be gathered and incorporated. Hence, modules MUST NOT be published at version 1.0.0 or higher at this time.

All module MUST be published as a pre-release version (e.g., 0.1.0, 0.1.1, 0.2.0, etc.) until the AVM framework becomes GA.

However, it is important to note that this DOES NOT mean that the modules cannot be consumed and utilized. They CAN be leveraged in all types of environments (dev, test, prod etc.). Consumers can treat them just like any other IaC module and raise issues or feature requests against them as they learn from the usage of the module. Consumers should also read the release notes for each version, if considering updating to a more recent version of a module to see if there are any considerations or breaking changes etc.

Requirements

The following requirements are needed by this module:

• terraform (>= 1.9, < 2.0)

• azapi (~> 2.4, < 3.0.0)

• azurerm (>=3.71, < 5.0.0)

• modtm (~> 0.3)

• random (~> 3.5)

Resources

The following resources are used by this module:

• azapi_resource.linked_storage_account (resource)
• azapi_resource.monitor_private_link_scope (resource)
• azurerm_application_insights.this (resource)
• azurerm_management_lock.this (resource)
• azurerm_role_assignment.this (resource)
• modtm_telemetry.telemetry (resource)
• random_uuid.telemetry (resource)
• azapi_client_config.telemetry (data source)
• modtm_module_source.telemetry (data source)

Required Inputs

The following input variables are required:

location

Description: Azure region where the resource should be deployed.

Type: string

name

Description: The name of the this resource.

Type: string

resource_group_name

Description: The resource group where the resources will be deployed.

Type: string

workspace_id

Description: (Required) The ID of the Log Analytics workspace to send data to. AzureRm supports classic; however, Azure has deprecated it, thus it's required

Type: string

Optional Inputs

The following input variables are optional (have default values):

application_type

Description: (Required) The type of the application. Possible values are 'web', 'ios', 'java', 'phone', 'MobileCenter', 'other', 'store'.

Type: string

Default: "web"

daily_data_cap_in_gb

Description: (Optional) The daily data cap in GB. 0 means unlimited.

Type: number

Default: 100

daily_data_cap_notifications_disabled

Description: (Optional) Disables the daily data cap notifications.

Type: bool

Default: false

disable_ip_masking

Description: (Optional) Disables IP masking. Defaults to false. For more information see https://aka.ms/avm/ipmasking.

Type: bool

Default: false

enable_telemetry

Description: This variable controls whether or not telemetry is enabled for the module.
For more information see https://aka.ms/avm/telemetryinfo.
If it is set to false, then no telemetry will be collected.

Type: bool

Default: true

force_customer_storage_for_profiler

Description: (Optional) Forces customer storage for profiler. Defaults to false.

Type: bool

Default: false

internet_ingestion_enabled

Description: (Optional) Enables internet ingestion. Defaults to true.

Type: bool

Default: true

internet_query_enabled

Description: (Optional) Enables internet query. Defaults to true.

Type: bool

Default: true

linked_storage_account

Description: Linked storage account configuration for the Application Insights profiler.

• resource_id - The resource ID of the storage account.

Type:

map(object({
    resource_id = optional(string, null)
  }))

Default: {}

local_authentication_disabled

Description: (Optional) Disables local authentication. Defaults to false.

Type: bool

Default: false

lock

Description: Controls the Resource Lock configuration for this resource. The following properties can be specified:

• kind - (Required) The type of lock. Possible values are \"CanNotDelete\" and \"ReadOnly\".
• name - (Optional) The name of the lock. If not specified, a name will be generated based on the kind value. Changing this forces the creation of a new resource.

Type:

object({
    kind = string
    name = optional(string, null)
  })

Default: null

managed_identities

Description: Controls the Managed Identity configuration on this resource. The following properties can be specified:

• system_assigned - (Optional) Specifies if the System Assigned Managed Identity should be enabled.
• user_assigned_resource_ids - (Optional) Specifies a list of User Assigned Managed Identity resource IDs to be assigned to this resource.

Type:

object({
    system_assigned            = optional(bool, false)
    user_assigned_resource_ids = optional(set(string), [])
  })

Default: {}

monitor_private_link_scope

Description: Monitor private link scope to connect the Application Insights resource to.

• resource_id - The resource ID of the monitor private link scope.
• name - The name of the scoped resource. Defaults to the Application Insights resource name.
• kind - The kind of the scoped resource. Defaults to Resource. Possible values are Resource or Metrics.
• subscription_location - The location of the subscription. This is required for kind Metrics.

Type:

map(object({
    resource_id           = optional(string, null)
    name                  = optional(string, null)
    kind                  = optional(string, "Resource")
    subscription_location = optional(string, null)
  }))

Default: {}

retention_in_days

Description: (Optional) The retention period in days. 0 means unlimited.

Type: number

Default: 90

role_assignments

Description: A map of role assignments to create on this resource. The map key is deliberately arbitrary to avoid issues where map keys maybe unknown at plan time.

• role_definition_id_or_name - The ID or name of the role definition to assign to the principal.
• principal_id - The ID of the principal to assign the role to.
• description - The description of the role assignment.
• skip_service_principal_aad_check - If set to true, skips the Azure Active Directory check for the service principal in the tenant. Defaults to false.
• condition - The condition which will be used to scope the role assignment.
• condition_version - The version of the condition syntax. Valid values are '2.0'.
• delegated_managed_identity_resource_id - The delegated Azure Resource Id which contains a Managed Identity. Changing this forces a new resource to be created.
• principal_type - The type of the principal_id. Possible values are User, Group and ServicePrincipal. Changing this forces a new resource to be created. It is necessary to explicitly set this attribute when creating role assignments if the principal creating the assignment is constrained by ABAC rules that filters on the PrincipalType attribute.

Note: only set skip_service_principal_aad_check to true if you are assigning a role to a service principal.

Type:

map(object({
    role_definition_id_or_name             = string
    principal_id                           = string
    description                            = optional(string, null)
    skip_service_principal_aad_check       = optional(bool, false)
    condition                              = optional(string, null)
    condition_version                      = optional(string, null)
    delegated_managed_identity_resource_id = optional(string, null)
    principal_type                         = optional(string, null)
  }))

Default: {}

sampling_percentage

Description: (Optional) The sampling percentage. 100 means all.

Type: number

Default: 100

tags

Description: (Optional) Tags of the resource.

Type: map(string)

Default: null

Outputs

The following outputs are exported:

app_id

Description: App ID of the Application Insights

connection_string

Description: Connection String of the Application Insights

instrumentation_key

Description: Instrumentation Key of the Application Insights

name

Description: Name of the Application Insights

resource

Description: This is the full output for the resource.

resource_id

Description: The ID of the Application Insights

Modules

No modules.

Data Collection

The software may collect information about you and your use of the software and send it to Microsoft. Microsoft may use this information to provide services and improve our products and services. You may turn off the telemetry as described in the repository. There are also some features in the software that may enable you and Microsoft to collect data from users of your applications. If you use these features, you must comply with applicable law, including providing appropriate notices to users of your applications together with a copy of Microsoft’s privacy statement. Our privacy statement is located at https://go.microsoft.com/fwlink/?LinkID=824704. You can learn more about data collection and use in the help documentation and our privacy statement. Your use of the software operates as your consent to these practices.