GitHunt
AZ

Azure/terraform-azurerm-avm-res-operationalinsights-workspace

Terraform Azure Verified Resource Module for Log Analytics workspace

azure-log-analyticsterraform-module

terraform-azurerm-avm-res-operationalinsights-workspace

This repo is to deploy an Log Analytics Workspace.

Major version Zero (0.y.z) is for initial development. Anything MAY change at any time. The module SHOULD NOT be considered stable till at least it is major version one (1.0.0) or greater. Changes will always be via new versions being published and no changes will be made to existing published versions. For more details please go to https://semver.org/

Requirements

The following requirements are needed by this module:

Resources

The following resources are used by this module:

Required Inputs

The following input variables are required:

location

Description: (Required) Specifies the suppored Azure location where the Log Analytics Workspace should exist. Changing this forces a new resource to be created

Type: string

name

Description: Specifies the name of the Log Analytics Workspace. Changing this forces a new resource to be created.

Type: string

resource_group_name

Description: (Required) Specifies the name of the Resource Group in which the Log Analytics Workspace should exist. Changing this forces a new resource to be created

Type: string

Optional Inputs

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

customer_managed_key

Description: A map describing customer-managed keys to associate with the resource. This includes the following properties:

  • key_vault_resource_id - The resource ID of the Key Vault where the key is stored.
  • key_name - The name of the key.
  • key_version - (Optional) The version of the key. If not specified, the latest version is used.
  • user_assigned_identity - (Optional) An object representing a user-assigned identity with the following properties:
    • resource_id - The resource ID of the user-assigned identity.

Type:

object({
    key_vault_resource_id = string
    key_name              = string
    key_version           = optional(string, null)
    user_assigned_identity = optional(object({
      resource_id = string
    }), null)
  })

Default: null

diagnostic_settings

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

  • name - (Optional) The name of the diagnostic setting. One will be generated if not set, however this will not be unique if you want to create multiple diagnostic setting resources.
  • log_categories - (Optional) A set of log categories to send to the log analytics workspace. Defaults to [].
  • log_groups - (Optional) A set of log groups to send to the log analytics workspace. Defaults to ["allLogs"].
  • metric_categories - (Optional) A set of metric categories to send to the log analytics workspace. Defaults to ["AllMetrics"].
  • log_analytics_destination_type - (Optional) The destination type for the diagnostic setting. Possible values are Dedicated and AzureDiagnostics. Defaults to Dedicated.
  • workspace_resource_id - (Optional) The resource ID of the log analytics workspace to send logs and metrics to.
  • storage_account_resource_id - (Optional) The resource ID of the storage account to send logs and metrics to.
  • event_hub_authorization_rule_resource_id - (Optional) The resource ID of the event hub authorization rule to send logs and metrics to.
  • event_hub_name - (Optional) The name of the event hub. If none is specified, the default event hub will be selected.
  • marketplace_partner_resource_id - (Optional) The full ARM resource ID of the Marketplace resource to which you would like to send Diagnostic LogsLogs.

Type:

map(object({
    name                                     = optional(string, null)
    log_categories                           = optional(set(string), [])
    log_groups                               = optional(set(string), ["allLogs"])
    metric_categories                        = optional(set(string), ["AllMetrics"])
    log_analytics_destination_type           = optional(string, "Dedicated")
    workspace_resource_id                    = optional(string, null)
    storage_account_resource_id              = optional(string, null)
    event_hub_authorization_rule_resource_id = optional(string, null)
    event_hub_name                           = optional(string, null)
    marketplace_partner_resource_id          = optional(string, null)
  }))

Default: {}

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

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

log_analytics_workspace_allow_resource_only_permissions

Description: (Optional) Specifies if the log Analytics Workspace allow users accessing to data associated with resources they have permission to view, without permission to workspace. Defaults to true.

Type: bool

Default: null

log_analytics_workspace_cmk_for_query_forced

Description: (Optional) Is Customer Managed Storage mandatory for query management?

Type: bool

Default: null

log_analytics_workspace_daily_quota_gb

Description: (Optional) The workspace daily quota for ingestion in GB. Defaults to -1 (unlimited) if omitted.

Type: number

Default: null

log_analytics_workspace_data_exports

Description: A map of data exports to create.

  • name - The name of the data export rule.
  • table_names - A list of table names to export.
  • destination_resource_id - The resource ID of the destination (Storage Account or Event Hub).
  • enabled - (Optional) Whether the data export is enabled. Defaults to true.
  • event_hub_name - (Optional) The name of the Event Hub. Required if destination_resource_id is an Event Hub Namespace ID.

Type:

map(object({
    name                    = string
    table_names             = list(string)
    destination_resource_id = string
    enabled                 = optional(bool, true)
    event_hub_name          = optional(string, null)
  }))

Default: {}

log_analytics_workspace_dedicated_cluster_resource_id

Description: (Optional) The resource ID of the dedicated cluster to link to the Log Analytics Workspace.

Type: string

Default: null

log_analytics_workspace_identity

Description: - identity_ids - (Optional) Specifies a list of user managed identity ids to be assigned. Required if type is UserAssigned.

  • type - (Required) Specifies the identity type of the Log Analytics Workspace. Possible values are SystemAssigned (where Azure will generate a Service Principal for you) and UserAssigned where you can specify the Service Principal IDs in the identity_ids field.

Type:

object({
    identity_ids = optional(set(string))
    type         = string
  })

Default: null

log_analytics_workspace_internet_ingestion_enabled

Description: (Optional) Should the Log Analytics Workspace support ingestion over the Public Internet? Possible values are true, false, and SecuredByPerimeter. Defaults to false.

Type: string

Default: "false"

log_analytics_workspace_internet_query_enabled

Description: (Optional) Should the Log Analytics Workspace support querying over the Public Internet? Possible values are true, false, and SecuredByPerimeter. Defaults to false.

Type: string

Default: "false"

log_analytics_workspace_linked_storage_accounts

Description: A map of linked storage accounts to create.

  • data_source_type - The data source type which should be used for this Log Analytics Linked Storage Account. Possible values are CustomLogs, AzureWatson, Query, Ingestion and Alerts.
  • storage_account_ids - A list of storage account resource IDs to link.

Type:

map(object({
    data_source_type    = string
    storage_account_ids = list(string)
  }))

Default: {}

log_analytics_workspace_local_authentication_enabled

Description: (Optional) Specifies if the log Analytics workspace should enforce authentication using Azure AD. Defaults to true.

Type: bool

Default: true

log_analytics_workspace_reservation_capacity_in_gb_per_day

Description: (Optional) The capacity reservation level in GB for this workspace. Possible values are 100, 200, 300, 400, 500, 1000, 2000 and 5000.

Type: number

Default: null

log_analytics_workspace_retention_in_days

Description: (Optional) The workspace data retention in days. Possible values are either 7 (Free Tier only) or range between 30 and 730.

Type: number

Default: null

log_analytics_workspace_sku

Description: (Optional) Specifies the SKU of the Log Analytics Workspace. Possible values are Free, PerNode, Premium, Standard, Standalone, Unlimited, CapacityReservation, and PerGB2018 (new SKU as of 2018-04-03). Defaults to PerGB2018.

Type: string

Default: null

log_analytics_workspace_tables

Description: A map of tables to create in the Log Analytics Workspace.

  • name - (Required) The name of the table.
  • resource_id - (Optional) The resource ID of the Log Analytics Workspace where the table will be created. If not specified, the table will be created in the Log Analytics Workspace created by this module.
  • retention_in_days - (Optional) The retention period for the table in days.
  • total_retention_in_days - (Optional) The total retention period for the table in days.
  • plan - (Optional) The plan for the table. Possible values are Basic and Analytics.
  • schema - (Optional) The schema of the table.
    • name - (Optional) The name of the schema.
    • description - (Optional) The description of the schema.
    • columns - (Optional) A list of columns in the schema.
      • name - (Required) The name of the column.
      • type - (Required) The type of the column. Possible values are boolean, datetime, dynamic, guid, int, long, real, and string.

Type:

map(object({
    name                    = string
    resource_id             = optional(string)
    retention_in_days       = optional(number)
    total_retention_in_days = optional(number)
    plan                    = optional(string)
    schema = optional(object({
      name        = optional(string)
      description = optional(string)
      columns = optional(list(object({
        name = string
        type = string
      })), [])
    }))
  }))

Default: {}

log_analytics_workspace_tables_update

Description: A map of tables to update in the Log Analytics Workspace. This is useful for updating default tables like Heartbeat or Syslog, or for adding new columns to existing tables.

  • name - (Required) The name of the table.
  • resource_id - (Optional) The resource ID of the Log Analytics Workspace where the table exists. If not specified, the table is assumed to be in the Log Analytics Workspace created by this module.
  • retention_in_days - (Optional) The retention period for the table in days.
  • total_retention_in_days - (Optional) The total retention period for the table in days.
  • plan - (Optional) The plan for the table. Possible values are Basic and Analytics.
  • schema - (Optional) The schema of the table. This can be used to add new columns to the table.
    • name - (Optional) The name of the schema.
    • description - (Optional) The description of the schema.
    • columns - (Optional) A list of columns in the schema.
      • name - (Required) The name of the column.
      • type - (Required) The type of the column. Possible values are boolean, datetime, dynamic, guid, int, long, real, and string.

Note: Removing a table from this map (destroying the update resource) does not revert the changes made to the table (e.g. removing columns). It simply stops managing the resource. To remove a column, you must explicitly update the schema with the column removed before removing the table from this map.

Type:

map(object({
    name                    = string
    resource_id             = optional(string)
    retention_in_days       = optional(number)
    total_retention_in_days = optional(number)
    plan                    = optional(string)
    schema = optional(object({
      name        = optional(string)
      description = optional(string)
      columns = optional(list(object({
        name = string
        type = string
      })), [])
    }))
  }))

Default: {}

log_analytics_workspace_timeouts

Description: - create - (Defaults to 30 minutes) Used when creating the Log Analytics Workspace.

  • delete - (Defaults to 30 minutes) Used when deleting the Log Analytics Workspace.
  • read - (Defaults to 5 minutes) Used when retrieving the Log Analytics Workspace.
  • update - (Defaults to 30 minutes) Used when updating the Log Analytics Workspace.

Type:

object({
    create = optional(string)
    delete = optional(string)
    read   = optional(string)
    update = optional(string)
  })

Default: null

Description: A map of Monitor Private Link Scopes to create. The map key is deliberately arbitrary to avoid issues where map keys maybe unknown at plan time.

  • name - (Optional) The name of the Monitor Private Link Scope. One will be generated if not set.
  • resource_id - (Required) The resource ID of the Resource Group where the Monitor Private Link Scope will be created.
  • ingestion_access_mode - (Optional) The ingestion access mode for the Monitor Private Link Scope. Possible values are PrivateOnly and Open. Defaults to PrivateOnly.
  • query_access_mode - (Optional) The query access mode for the Monitor Private Link Scope. Possible values are PrivateOnly and Open. Defaults to PrivateOnly.
  • exclusions - (Optional) A list of exclusions to apply to the Monitor Private Link Scope.
    • ingestion_access_mode - (Optional) The ingestion access mode for the exclusion. Possible values are PrivateOnly and Open. Defaults to PrivateOnly.
    • query_access_mode - (Optional) The query access mode for the exclusion. Possible values are PrivateOnly and Open. Defaults to PrivateOnly.
    • private_endpoint_connection_name - (Required) The name of the private endpoint connection to exclude.
  • lock - (Optional) 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.

Note: If the map key matches a key in var.private_endpoints, the private endpoint connection created by this module will be automatically added to the exclusions list unless monitor_private_link_scope_exclusion.exclude is set to false in the private endpoint configuration. The access modes default to PrivateOnly but can be customized via monitor_private_link_scope_exclusion. You can also manually add an exclusion with the same private_endpoint_connection_name in the exclusions list of this variable, but using the private endpoint configuration is recommended.

Type:

map(object({
    name                  = optional(string)
    resource_id           = string
    ingestion_access_mode = optional(string, "PrivateOnly")
    query_access_mode     = optional(string, "PrivateOnly")
    exclusions = optional(list(object({
      ingestion_access_mode            = optional(string, "PrivateOnly")
      query_access_mode                = optional(string, "PrivateOnly")
      private_endpoint_connection_name = string
    })), [])
    lock = optional(object({
      kind = string
      name = optional(string, null)
    }))
  }))

Default: {}

Description: - name - Defaults to the name of the Log Analytics Workspace.

  • resource_id - Resource ID of an existing Monitor Private Link Scope to connect to.
  • exclusions - (Optional) A list of exclusions to apply to the Monitor Private Link Scope.
    • ingestion_access_mode - (Optional) The ingestion access mode for the exclusion. Possible values are PrivateOnly and Open. Defaults to PrivateOnly.
    • query_access_mode - (Optional) The query access mode for the exclusion. Possible values are PrivateOnly and Open. Defaults to PrivateOnly.
    • private_endpoint_connection_name - (Required) The name of the private endpoint connection to exclude.

Type:

map(object({
    name        = optional(string)
    resource_id = string
    exclusions = optional(list(object({
      ingestion_access_mode            = optional(string, "PrivateOnly")
      query_access_mode                = optional(string, "PrivateOnly")
      private_endpoint_connection_name = string
    })), [])
  }))

Default: {}

Description: The name of the service to connect to the Monitor Private Link Scope.

Type: string

Default: null

network_security_perimeter_association

Description: (Optional) The Network Security Perimeter (NSP) association configuration.

  • resource_id - (Required) The resource ID of the Network Security Perimeter.
  • profile_name - (Required) The name of the NSP profile to associate with.
  • access_mode - (Optional) The access mode for the association. Possible values are Learning, Enforced, and Audit. Defaults to Learning.

Type:

object({
    resource_id  = string
    profile_name = string
    access_mode  = optional(string, "Learning")
  })

Default: null

private_endpoint_extensions

Description: A map of extensions to apply to the private endpoints. The map key must match the key in var.private_endpoints.

  • monitor_private_link_scope_key - (Optional) The key of the Monitor Private Link Scope to associate with the private endpoint.
  • monitor_private_link_scope_exclusion - (Optional) The exclusion configuration for the Monitor Private Link Scope.
    • exclude - (Optional) Whether to exclude the private endpoint from the Monitor Private Link Scope. Defaults to true.
    • ingestion_access_mode - (Optional) The ingestion access mode for the exclusion. Possible values are PrivateOnly and Open. Defaults to PrivateOnly.
    • query_access_mode - (Optional) The query access mode for the exclusion. Possible values are PrivateOnly and Open. Defaults to PrivateOnly.
  • manage_dns_zone_group - (Optional) Whether to manage private DNS zone groups with this module. If set to false, you must manage private DNS zone groups externally, e.g. using Azure Policy. Defaults to true.

Type:

map(object({
    monitor_private_link_scope_key = optional(string, null)
    monitor_private_link_scope_exclusion = optional(object({
      exclude               = optional(bool, true)
      ingestion_access_mode = optional(string, "PrivateOnly")
      query_access_mode     = optional(string, "PrivateOnly")
    }), null)
    manage_dns_zone_group = optional(bool, true)
  }))

Default: {}

private_endpoints

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

  • name - (Optional) The name of the private endpoint. One will be generated if not set.
  • role_assignments - (Optional) A map of role assignments to create on the private endpoint. The map key is deliberately arbitrary to avoid issues where map keys maybe unknown at plan time. See var.role_assignments for more information.
  • lock - (Optional) The lock level to apply to the private endpoint. Default is None. Possible values are None, CanNotDelete, and ReadOnly.
  • tags - (Optional) A mapping of tags to assign to the private endpoint.
  • subnet_resource_id - The resource ID of the subnet to deploy the private endpoint in.
  • private_dns_zone_group_name - (Optional) The name of the private DNS zone group. One will be generated if not set.
  • private_dns_zone_resource_ids - (Optional) A set of resource IDs of private DNS zones to associate with the private endpoint. If not set, no zone groups will be created and the private endpoint will not be associated with any private DNS zones. DNS records must be managed external to this module.
  • application_security_group_resource_ids - (Optional) A map of resource IDs of application security groups to associate with the private endpoint. The map key is deliberately arbitrary to avoid issues where map keys maybe unknown at plan time.
  • private_service_connection_name - (Optional) The name of the private service connection. One will be generated if not set.
  • network_interface_name - (Optional) The name of the network interface. One will be generated if not set.
  • location - (Optional) The Azure location where the resources will be deployed. Defaults to the location of the resource group.
  • resource_group_name - (Optional) The resource group where the resources will be deployed. Defaults to the resource group of the Key Vault.
  • ip_configurations - (Optional) A map of IP configurations to create on the private endpoint. If not specified the platform will create one. The map key is deliberately arbitrary to avoid issues where map keys maybe unknown at plan time.
    • name - The name of the IP configuration.
    • private_ip_address - The private IP address of the IP configuration.

Type:

map(object({
    name = optional(string, null)
    role_assignments = optional(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)
    })), {})
    lock = optional(object({
      kind = string
      name = optional(string, null)
    }), null)
    tags                                    = optional(map(string), null)
    subnet_resource_id                      = string
    private_dns_zone_group_name             = optional(string, "default")
    private_dns_zone_resource_ids           = optional(set(string), [])
    application_security_group_associations = optional(map(string), {})
    private_service_connection_name         = optional(string, null)
    network_interface_name                  = optional(string, null)
    location                                = optional(string, null)
    resource_group_name                     = optional(string, null)
    ip_configurations = optional(map(object({
      name               = string
      private_ip_address = string
    })), {})
  }))

Default: {}

role_assignments

Description: A map of role assignments to create on the . 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 - (Optional) The description of the role assignment.
  • skip_service_principal_aad_check - (Optional) If set to true, skips the Azure Active Directory check for the service principal in the tenant. Defaults to false.
  • condition - (Optional) The condition which will be used to scope the role assignment.
  • condition_version - (Optional) The version of the condition syntax. Leave as null if you are not using a condition, if you are then valid values are '2.0'.
  • delegated_managed_identity_resource_id - (Optional) The delegated Azure Resource Id which contains a Managed Identity. Changing this forces a new resource to be created. This field is only used in cross-tenant scenario.
  • principal_type - (Optional) The type of the principal_id. Possible values are User, Group and ServicePrincipal. 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: {}

tags

Description: (Optional) Tags of the resource.

Type: map(string)

Default: null

Outputs

The following outputs are exported:

private_endpoints

Description: A map of the private endpoints created.

resource

Description: "This is the full output for the Log Analytics resource. This is the default output for the module following AVM standards. Review the examples below for the correct output to use in your module."
Examples:

  • module.log_analytics.resource.id
  • module.log_analytics.resource.name

resource_id

Description: This is the full output for the Log Analytics resource ID. This is the default output for the module following AVM standards. Review the examples below for the correct output to use in your module.

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.

Languages

HCL89.8%PowerShell5.2%Shell4.7%Makefile0.2%Batchfile0.0%Go0.0%
MIT License
Created October 18, 2023
Updated January 27, 2026